mirror of
https://github.com/Erreur32/cheat.git
synced 2024-12-22 13:42:11 +01:00
Updated the README to document the usage of the $CHEATPATH environment variable.
This commit is contained in:
parent
b8c42a1b64
commit
40d18e01dc
1 changed files with 17 additions and 0 deletions
17
README.md
17
README.md
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue