mirror of
https://github.com/cheat/cheat.git
synced 2024-11-22 05:51:35 +01:00
Updated the README to mention the new create/edit abilities.
This commit is contained in:
parent
d183a6fb14
commit
3e7dcc9b43
22
README.md
22
README.md
@ -105,12 +105,32 @@ export CHEATPATH=$CHEATPATH:/path/to/more/cheats
|
|||||||
Enabling Syntax Highlighting
|
Enabling Syntax Highlighting
|
||||||
----------------------------
|
----------------------------
|
||||||
`cheat` can apply syntax highlighting to your cheatsheets if so desired. To
|
`cheat` can apply syntax highlighting to your cheatsheets if so desired. To
|
||||||
enable this feature, set a `$CHEATCOLORS` environment variable:
|
enable this feature, set a `CHEATCOLORS` environment variable:
|
||||||
|
|
||||||
```bash
|
```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 -c foo
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, `cheat` will attempt to write the new cheatsheet to `~/.cheat`,
|
||||||
|
creating the `~/.cheat` directory if necessary. (If it is unable to do so, the
|
||||||
|
new cheatsheet will be written to the default cheatsheet directory instead,
|
||||||
|
though this will likely require `sudo`.)
|
||||||
|
|
||||||
|
Likewise, an existing cheatsheet may be edited via:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cheat -e foo
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
|
Loading…
Reference in New Issue
Block a user