mirror of
https://github.com/cheat/cheat.git
synced 2026-03-07 03:03:32 +01:00
Performed a large refactoring
Performed an extensive refactoring on the entire application for the sake of code-cleanliness. - Refactored out of an ad-hoc Imperative paradigm into more of a functional/declarative paradigm. IMO, this makes the application signifcantly easier to understand. - Moved away from `argparse` and into `docopt` for argument parsing - Version bump to 2.0.0 - Performed extensive refactoring on the setup.py script. Script should install to the system more cleanly now. - Made minor formatting changes to the --list flag output - Updated the README Squashed commit of the following: commit e5681bd536aa0220cdeb7884cc248db55be408c9 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 23:30:21 2014 -0400 Fixed many bugs Everything seems to work now, I think. commit 764ec5950cee958eb1b8333ddfcb6bcd45c28429 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 21:51:31 2014 -0400 Restructuring for the sake of setup.py Seem to finally have a working install script commit 5a866c23857b77ec65070dd8023cd734f2b7c242 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 18:01:11 2014 -0400 Nits commit a79954ba5b33d992fa6a32abffb33b161d624e3d Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 17:53:03 2014 -0400 Implemented search commit b570a897e9a12c15affe1a72628deae31836dee2 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 17:11:27 2014 -0400 Nits commit 1a8d85b44457f1b2131b3e8475c5270b5d0899e3 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 17:02:22 2014 -0400 Still refactoring across files Trying to make the program structure clearer commit 34dffd6462e492e81ea558e2009a71051b7663c9 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 16:40:37 2014 -0400 Breaking app into several files This is for the sake of code-cleanliness commit 4825d678ff5f9817ccbf727ef71e5dea15ff2586 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 15:55:19 2014 -0400 Got syntax highlighting working commit c37d7a626d451bfca3d4a072eb9fed604085170f Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 15:29:22 2014 -0400 Reduced verbosity of function names commit 8e626045186b37dce2480f5af1994ddfa8db79b5 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 15:24:41 2014 -0400 Refactored argument passing Fewer arguments now need to be passed throughout the app. commit 807ba814650010b3dd1b59d27400b3fb4fcfede7 Author: Chris Lane <chris@chris-allen-lane.com> Date: Sat Apr 26 11:40:05 2014 -0400 Working through the refactor commit e34e6540d4f8cd727e98aac68289d515a02d5fe6 Author: Chris Lane <chris@chris-allen-lane.com> Date: Thu Apr 24 20:00:10 2014 -0400 Got a basic end-to-end refactor working Have re-implemented just the most basic functionality in the "cheat2" file.
This commit is contained in:
54
README.md
54
README.md
@@ -7,7 +7,7 @@ remember.
|
||||
|
||||

|
||||
|
||||
`cheat` depends only on python.
|
||||
`cheat` depends only on `python` and `pip`.
|
||||
|
||||
|
||||
Examples
|
||||
@@ -15,9 +15,7 @@ Examples
|
||||
The next time you're forced to disarm a nuclear weapon without consulting
|
||||
Google, you may run:
|
||||
|
||||
```sh
|
||||
cheat tar
|
||||
```
|
||||
cheat tar
|
||||
|
||||
You will be presented with a cheatsheet resembling:
|
||||
|
||||
@@ -38,7 +36,7 @@ tar -xjvf /path/to/foo.tgz
|
||||
tar -cjvf /path/to/foo.tgz /path/to/foo/
|
||||
```
|
||||
|
||||
To see what cheatsheets are availble, run `cheat` with no arguments.
|
||||
To see what cheatsheets are availble, run `cheat -l`.
|
||||
|
||||
Note that, while `cheat` was designed primarily for *nix system administrators,
|
||||
it is agnostic as to what content it stores. If you would like to use `cheat`
|
||||
@@ -47,38 +45,14 @@ to store notes on your favorite cookie recipes, feel free.
|
||||
|
||||
Installing
|
||||
==========
|
||||
First install the required python dependencies with:
|
||||
|
||||
### Installing for all users (requires root)
|
||||
sudo pip install docopt pygments
|
||||
|
||||
Clone this repository and `cd` into it, then run
|
||||
Then, clone this repository, `cd` into it, and 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
|
||||
|
||||
### Testing
|
||||
|
||||
After installing for all users or in your home directory, try `cheat tar` for instance.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
In case you got an error such as:
|
||||
> ImportError: No module named argparse
|
||||
|
||||
You're probably using python < 2.7 and you need to manually install the argparse module.
|
||||
You can do this easily with pip:
|
||||
```bash
|
||||
sudo apt-get install python-pip
|
||||
sudo pip install argparse
|
||||
```
|
||||
Other methods: https://pypi.python.org/pypi/argparse
|
||||
|
||||
Modifying Cheatsheets
|
||||
=====================
|
||||
@@ -118,15 +92,11 @@ Setting a CHEATPATH
|
||||
You can additionally instruct `cheat` to look for cheatsheets in other
|
||||
directories by exporting a `CHEATPATH` environment variable:
|
||||
|
||||
```bash
|
||||
export CHEATPATH=/path/to/my/cheats
|
||||
```
|
||||
export CHEATPATH=/path/to/my/cheats
|
||||
|
||||
You may, of course, append multiple directories to your `CHEATPATH`:
|
||||
|
||||
```bash
|
||||
export CHEATPATH=$CHEATPATH:/path/to/more/cheats
|
||||
```
|
||||
export CHEATPATH=$CHEATPATH:/path/to/more/cheats
|
||||
|
||||
You may view which directories are on your `CHEATPATH` with `cheat -d`.
|
||||
|
||||
@@ -135,18 +105,14 @@ Enabling Syntax Highlighting
|
||||
`cheat` can apply syntax highlighting to your cheatsheets if so desired. To
|
||||
enable this feature, set a `CHEATCOLORS` environment variable:
|
||||
|
||||
```bash
|
||||
export CHEATCOLORS=true
|
||||
```
|
||||
export CHEATCOLORS=true
|
||||
|
||||
Creating/Editing Cheatsheets
|
||||
----------------------------
|
||||
Provided that you have an `EDITOR` environment variable set, you may create new
|
||||
cheatsheets via:
|
||||
|
||||
```bash
|
||||
cheat -e foo
|
||||
```
|
||||
cheat -e foo
|
||||
|
||||
If the 'foo' cheatsheet already exists, it will be opened for editing.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user