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

docs(README): update the `README` 

Update the `README` to document the improved config-generation
mechanism.
This commit is contained in:
Chris Lane 2020-03-06 19:56:56 -05:00
parent 803e1f014c
commit 5c322e79b7
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -51,7 +51,9 @@ Installing
Configuring Configuring
----------- -----------
### conf.yml ### ### conf.yml ###
`cheat` is configured by a YAML file that can be generated with `cheat --init`: `cheat` is configured by a YAML file that will be auto-generated on first run.
Should you need to create a config file manually, you can do
so via:
```sh ```sh
mkdir -p ~/.config/cheat && cheat --init > ~/.config/cheat/conf.yml mkdir -p ~/.config/cheat && cheat --init > ~/.config/cheat/conf.yml
@ -89,7 +91,8 @@ const squares = [1, 2, 3, 4].map(x => x * x);
``` ```
The `cheat` executable includes no cheatsheets, but [community-sourced The `cheat` executable includes no cheatsheets, but [community-sourced
cheatsheets are available][cheatsheets]. cheatsheets are available][cheatsheets]. You will be asked if you would like to
install the community-sourced cheatsheets the first time you run `cheat`.
Cheatpaths Cheatpaths