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 document the usage of the $CHEATPATH environment variable.

This commit is contained in:
Chris Lane 2013-08-15 18:52:32 -04:00
parent b8c42a1b64
commit 40d18e01dc
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -77,6 +77,23 @@ After you've customized your cheatsheets, I urge you to track `~/.cheat/` along
with your [dotfiles][].
Setting a `$CHEATPATH`
----------------------
By default, all cheatsheets are installed to `~/.cheat/`, but you can instruct
`cheat` to look for cheatsheets in other directories by exporting a `CHEATPATH`
environment variable:
```bash
export CHEATPATH=/path/to/my/cheats
```
You may, of course, append multiple directories to your `CHEATPATH`:
```bash
export CHEATPATH=$CHEATPATH:/path/to/more/cheats
```
Contributing
------------
If you would like to contribute additional cheatsheets for basic \*nix