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

README edits 

Updated the names of the (preferred) cheat-related environment
variables, which have been changed in recent versions.
This commit is contained in:
Chris Lane 2019-01-29 11:31:03 -05:00
parent 9ea60d12ff
commit 09acdf1a69
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -83,37 +83,37 @@ with your [dotfiles][].
Configuring Configuring
----------- -----------
### Setting a DEFAULT_CHEAT_DIR ### ### Setting a CHEAT_DEFAULT_DIR ###
Personal cheatsheets are saved in the `~/.cheat` directory by default, but you Personal cheatsheets are saved in the `~/.cheat` directory by default, but you
can specify a different default by exporting a `DEFAULT_CHEAT_DIR` environment can specify a different default by exporting a `CHEAT_DEFAULT_DIR` environment
variable: variable:
```sh ```sh
export DEFAULT_CHEAT_DIR='/path/to/my/cheats' export CHEAT_DEFAULT_DIR='/path/to/my/cheats'
``` ```
### Setting a CHEATPATH ### ### Setting a CHEAT_PATH ###
You can additionally instruct `cheat` to look for cheatsheets in other You can additionally instruct `cheat` to look for cheatsheets in other
directories by exporting a `CHEATPATH` environment variable: directories by exporting a `CHEAT_PATH` environment variable:
```sh ```sh
export CHEATPATH='/path/to/my/cheats' export CHEAT_PATH='/path/to/my/cheats'
``` ```
You may, of course, append multiple directories to your `CHEATPATH`: You may, of course, append multiple directories to your `CHEAT_PATH`:
```sh ```sh
export CHEATPATH="$CHEATPATH:/path/to/more/cheats" export CHEAT_PATH="$CHEAT_PATH:/path/to/more/cheats"
``` ```
You may view which directories are on your `CHEATPATH` with `cheat -d`. You may view which directories are on your `CHEAT_PATH` with `cheat -d`.
### Enabling Syntax Highlighting ### ### Enabling Syntax Highlighting ###
`cheat` can optionally apply syntax highlighting to your cheatsheets. To `cheat` can optionally apply syntax highlighting to your cheatsheets. To
enable syntax highlighting, export a `CHEATCOLORS` environment variable: enable syntax highlighting, export a `CHEAT_COLORS` environment variable:
```sh ```sh
export CHEATCOLORS=true export CHEAT_COLORS=true
``` ```
Note that [pygments][] must be installed on your system for this to work. Note that [pygments][] must be installed on your system for this to work.