echosystem.fr
/
cheat
mirror of https://github.com/cheat/cheat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated the README.

This commit is contained in:
Chris Lane 2013-09-14 11:35:16 -04:00
parent 30e4078688
commit f1cdfa6dd9
1 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -128,25 +128,16 @@ Creating/Editing Cheatsheets
Provided that you have an `EDITOR` environment variable set, you may create new
cheatsheets via:
```bash
cheat -c foo
```
By default, `cheat` will attempt to write the new cheatsheet to `~/.cheat`,
creating the `~/.cheat` directory if necessary. (If it is unable to do so, the
new cheatsheet will be written to the default cheatsheet directory instead,
though this will likely require `sudo`.)
Likewise, an existing cheatsheet may be edited via:
```bash
cheat -e foo
```
Command Autocompletion in zsh
-----------------------------
`zsh` users may use `cheat -d` in coordination with the provided `\_cheat` file
to implement autocompletion [as described here][4].
If the 'foo' cheatsheet already exists, it will be opened for editing.
By default, `cheat` will attempt to write new cheatsheets to `~/.cheat`, and
will create the `~/.cheat` directory if necessary. If it is unable to do so,
the new cheatsheet will be written to the default cheatsheet directory instead,
though this will likely require `sudo`.
Contributing