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

Add a non-root section to the installation guide.

This commit is contained in:
Louis Taylor 2013-08-16 09:19:04 +01:00
parent 63b0ffba14
commit 1944c1a351
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -47,15 +47,21 @@ to store notes on your favorite cookie recipes, feel free.
Installing
----------
Do the following to install `cheat`:
1. Clone this repository and `cd` into it
2. Run `$ sudo python setup.py install`
### Installing for all users (requires root)
The `install` script will copy a python file into `/usr/local/bin/`, and will
also create a hidden `.cheat` folder (containing the cheatsheet content) in
your home directory.
Clone this repository and `cd` into it, then run
sudo python setup.py install
### Installing in your home directory
Clone this repository and `cd` into it, then run
mkdir -p ~/bin
cp cheat ~/bin
mkdir ~/.cheat
cp cheatsheets/* ~/.cheat
Modifying Cheatsheets
---------------------