From 40d18e01dcf286cb10a74d38f481cbe49c232a03 Mon Sep 17 00:00:00 2001 From: Chris Lane Date: Thu, 15 Aug 2013 18:52:32 -0400 Subject: [PATCH] Updated the README to document the usage of the $CHEATPATH environment variable. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 8d75aac..c44d027 100644 --- a/README.md +++ b/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