diff --git a/README.md b/README.md index c4371f1..600eaf5 100644 --- a/README.md +++ b/README.md @@ -109,13 +109,16 @@ export CHEATPATH="$CHEATPATH:/path/to/more/cheats" You may view which directories are on your `CHEATPATH` with `cheat -d`. ### Enabling Syntax Highlighting ### -`cheat` can optionally apply syntax highlighting to your cheatsheets. To can use this feature is -neccessary to install the package [Pygments](http://pygments.org/). To enable syntax highlighting, export a `CHEATCOLORS` environment variable: +`cheat` can optionally apply syntax highlighting to your cheatsheets. To +enable syntax highlighting, export a `CHEATCOLORS` environment variable: ```sh export CHEATCOLORS=true ``` +Note that [pygments][] must be installed on your system for this to work. + + #### Specifying a Syntax Highlighter #### You may manually specify which syntax highlighter to use for each cheatsheet by wrapping the sheet's contents in a [Github-Flavored Markdown code-fence][gfm]. @@ -145,4 +148,5 @@ See Also: [dotfiles]: http://dotfiles.github.io/ [gfm]: https://help.github.com/articles/creating-and-highlighting-code-blocks/ [installing]: https://github.com/chrisallenlane/cheat/wiki/Installing +[pygments]: http://pygments.org/ [related-projects]: https://github.com/chrisallenlane/cheat/wiki/Related-Projects