added formatting, requirements, and usage
This commit is contained in:
parent
fe069eab7d
commit
95742a7e15
1 changed files with 20 additions and 5 deletions
25
README.md
25
README.md
|
|
@ -1,12 +1,27 @@
|
||||||
# skratch
|
# skratch
|
||||||
|
|
||||||
A cli program to create and edit temporary files
|
# Skratch
|
||||||
|
|
||||||
Installation:
|
A cli program to quickly create and edit temporary files
|
||||||
|
|
||||||
mv skratch.py /usr/bin/skratch
|
Requirements:
|
||||||
|
python3 > 3.6
|
||||||
|
|
||||||
|
## Installation:
|
||||||
|
|
||||||
|
mv skratch.py /usr/local/bin/skratch
|
||||||
|
chmod +x /usr/local/bin/skratch
|
||||||
|
|
||||||
set an env variable for $EDITOR and/or $VISUAL in .bashrc
|
set an env variable for $EDITOR and/or $VISUAL in .bashrc
|
||||||
|
|
||||||
export EDITOR=vi
|
export EDITOR=vi
|
||||||
export VISUAL=geany
|
export VISUAL=geany
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
`skratch` creates a random file in .skratch and opens it in the EDITOR
|
||||||
|
`-c` clears/deletes all files in .skratch
|
||||||
|
`-l` lists files in .skratch
|
||||||
|
`-o <filename>` opens a specific file
|
||||||
|
`-v` opens the VISUAL editor
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue