diff --git a/Installing.md b/Installing.md new file mode 100644 index 0000000..b70c9ce --- /dev/null +++ b/Installing.md @@ -0,0 +1,33 @@ +There are several methods for installing `cheat` on your system. + +### pip ### +`pip` is the recommended installation method for most users. Simply run: + +```sh +[sudo] pip install cheat +``` + +### homebrew ### +To install `cheat` using homebrew, run: + +```sh +brew install cheat +``` + +### manually ### +First, install the dependencies: + +```sh +[sudo] pip install docopt pygments pyxdg +``` + +Then clone this repository: +```sh +git clone git@github.com:chrisallenlane/cheat.git +``` + +Lastly, `cd` into the cloned directory, then run: + +```sh +[sudo] python setup.py install +``` \ No newline at end of file