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

Updated the README to mention the new create/edit abilities.

This commit is contained in:
Chris Lane 2013-08-26 21:05:05 -04:00
parent d183a6fb14
commit 3e7dcc9b43
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -105,12 +105,32 @@ export CHEATPATH=$CHEATPATH:/path/to/more/cheats
Enabling Syntax Highlighting
----------------------------
`cheat` can apply syntax highlighting to your cheatsheets if so desired. To
enable this feature, set a `$CHEATCOLORS` environment variable:
enable this feature, set a `CHEATCOLORS` environment variable:
```bash
export CHEATCOLORS=true
```
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
```
Contributing
============