chubin/cheat.sh
1
1
Fork 0
mirror of https://github.com/chubin/cheat.sh.git synced 2024-11-29 23:36:40 +03:00
Code Issues Projects Releases Wiki Activity

Add reference do doc/standalone.md (#14, #97, #98)

Browse Source
This commit is contained in:
Igor Chubin 2021-01-01 18:15:46 +01:00
parent 831f4c5078
commit 6f688ef447
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -22,10 +22,10 @@ Such a thing exists.
**cheat.sh** **cheat.sh**
* Has a simple curl/browser interface. * Has a simple curl/browser/editor interface.
* Covers 56 programming languages, several DBMSes, and more than 1000 most important UNIX/Linux commands. * Covers 56 programming languages, several DBMSes, and more than 1000 most important UNIX/Linux commands.
* Provides access to the best community driven cheat sheets repositories in the world, on par with StackOverflow. * Provides access to the best community driven cheat sheets repositories in the world, on par with StackOverflow.
* Available everywhere, no installation needed. * Available everywhere, no installation needed, but can be installed for offline usage.
* Ultrafast, returns answers within 100 ms, as a rule. * Ultrafast, returns answers within 100 ms, as a rule.
* Has a convenient command line client, `cht.sh`, that is very advantageous and helpful, though not mandatory. * Has a convenient command line client, `cht.sh`, that is very advantageous and helpful, though not mandatory.
* Can be used directly from code editors, without opening a browser and not switching your mental context. * Can be used directly from code editors, without opening a browser and not switching your mental context.
@ -865,3 +865,15 @@ If you want to add a cheat sheet repository to cheat.sh, please open an issue:
* [Add a new repository](https://github.com/chubin/cheat.sh/issues/new) * [Add a new repository](https://github.com/chubin/cheat.sh/issues/new)
Please specify the name of the repository, and give its short description. Please specify the name of the repository, and give its short description.
## Installation and standalone usage
You don't need to install anything, to start using *cheat.sh*.
There are two cases, when you want to install *cheat.sh* locally:
1. You plan to use it off-line, without Internet access;
2. You want to use your own cheat sheets (additionally, or as a replacement).
Installation process in described in details here: [cheat.sh standalone installation](doc/standalone.md)