mirror of
https://github.com/cheat/cheat.git
synced 2025-09-01 09:38:29 +02:00
Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
c922ef4c8d | |||
574a7ec3c9 | |||
5ae49228b7 | |||
09acdf1a69 |
22
README.md
22
README.md
@ -83,37 +83,37 @@ with your [dotfiles][].
|
||||
Configuring
|
||||
-----------
|
||||
|
||||
### Setting a DEFAULT_CHEAT_DIR ###
|
||||
### Setting a CHEAT_DEFAULT_DIR ###
|
||||
Personal cheatsheets are saved in the `~/.cheat` directory by default, but you
|
||||
can specify a different default by exporting a `DEFAULT_CHEAT_DIR` environment
|
||||
can specify a different default by exporting a `CHEAT_DEFAULT_DIR` environment
|
||||
variable:
|
||||
|
||||
```sh
|
||||
export DEFAULT_CHEAT_DIR='/path/to/my/cheats'
|
||||
export CHEAT_DEFAULT_DIR='/path/to/my/cheats'
|
||||
```
|
||||
|
||||
### Setting a CHEATPATH ###
|
||||
### Setting a CHEAT_PATH ###
|
||||
You can additionally instruct `cheat` to look for cheatsheets in other
|
||||
directories by exporting a `CHEATPATH` environment variable:
|
||||
directories by exporting a `CHEAT_PATH` environment variable:
|
||||
|
||||
```sh
|
||||
export CHEATPATH='/path/to/my/cheats'
|
||||
export CHEAT_PATH='/path/to/my/cheats'
|
||||
```
|
||||
|
||||
You may, of course, append multiple directories to your `CHEATPATH`:
|
||||
You may, of course, append multiple directories to your `CHEAT_PATH`:
|
||||
|
||||
```sh
|
||||
export CHEATPATH="$CHEATPATH:/path/to/more/cheats"
|
||||
export CHEAT_PATH="$CHEAT_PATH:/path/to/more/cheats"
|
||||
```
|
||||
|
||||
You may view which directories are on your `CHEATPATH` with `cheat -d`.
|
||||
You may view which directories are on your `CHEAT_PATH` with `cheat -d`.
|
||||
|
||||
### Enabling Syntax Highlighting ###
|
||||
`cheat` can optionally apply syntax highlighting to your cheatsheets. To
|
||||
enable syntax highlighting, export a `CHEATCOLORS` environment variable:
|
||||
enable syntax highlighting, export a `CHEAT_COLORS` environment variable:
|
||||
|
||||
```sh
|
||||
export CHEATCOLORS=true
|
||||
export CHEAT_COLORS=true
|
||||
```
|
||||
|
||||
Note that [pygments][] must be installed on your system for this to work.
|
||||
|
@ -47,7 +47,7 @@ import os
|
||||
if __name__ == '__main__':
|
||||
|
||||
# parse the command-line options
|
||||
options = docopt(__doc__, version='cheat 2.4.1')
|
||||
options = docopt(__doc__, version='cheat 2.4.2')
|
||||
|
||||
config = Configuration()
|
||||
sheets = Sheets(config)
|
||||
|
3
setup.py
3
setup.py
@ -14,7 +14,7 @@ for f in os.listdir('cheat/cheatsheets/'):
|
||||
# specify build params
|
||||
setup(
|
||||
name = 'cheat',
|
||||
version = '2.4.1',
|
||||
version = '2.4.2',
|
||||
author = 'Chris Lane',
|
||||
author_email = 'chris@chris-allen-lane.com',
|
||||
license = 'GPL3',
|
||||
@ -31,6 +31,7 @@ setup(
|
||||
install_requires = [
|
||||
'docopt >= 0.6.1',
|
||||
'pygments >= 1.6.0',
|
||||
'termcolor >= 1.1.0',
|
||||
],
|
||||
data_files = [
|
||||
(cheat_path, cheat_files),
|
||||
|
Reference in New Issue
Block a user