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 describe the -d flag and zsh coordination.

This commit is contained in:
Chris Lane 2013-09-07 14:38:13 -04:00
parent b107019664
commit 213c7a31e1
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -63,6 +63,7 @@ Clone this repository and `cd` into it, then run
mkdir ~/.cheat mkdir ~/.cheat
cp cheatsheets/* ~/.cheat cp cheatsheets/* ~/.cheat
Modifying Cheatsheets Modifying Cheatsheets
===================== =====================
The value of `cheat` is that it allows you to create your own cheatsheets - the The value of `cheat` is that it allows you to create your own cheatsheets - the
@ -111,6 +112,8 @@ You may, of course, append multiple directories to your `CHEATPATH`:
export CHEATPATH=$CHEATPATH:/path/to/more/cheats export CHEATPATH=$CHEATPATH:/path/to/more/cheats
``` ```
You may view which directories are on your `CHEATPATH` with `cheat -d`.
Enabling Syntax Highlighting Enabling Syntax Highlighting
---------------------------- ----------------------------
`cheat` can apply syntax highlighting to your cheatsheets if so desired. To `cheat` can apply syntax highlighting to your cheatsheets if so desired. To
@ -140,12 +143,18 @@ Likewise, an existing cheatsheet may be edited via:
cheat -e foo 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].
Contributing Contributing
============ ============
If you would like to contribute cheetsheets or program functionality, please If you would like to contribute cheetsheets or program functionality, please
fork this repository, make your chanages, and send me a pull request. fork this repository, make your chanages, and send me a pull request.
Related Projects Related Projects
================ ================
@ -166,3 +175,4 @@ Related Projects
[1]: https://github.com/lucaswerkmeister/cheats [1]: https://github.com/lucaswerkmeister/cheats
[2]: https://github.com/jahendrie/cheat [2]: https://github.com/jahendrie/cheat
[3]: http://errtheblog.com/posts/21-cheat [3]: http://errtheblog.com/posts/21-cheat
[4]: https://github.com/chrisallenlane/cheat/pull/77