2
0
mirror of https://github.com/chubin/cheat.sheets synced 2024-11-17 09:25:32 +00:00
cheat.sheets/README.md

39 lines
906 B
Markdown
Raw Normal View History

2017-05-07 21:38:41 +00:00
# cheat.sheets
2017-05-08 20:33:58 +00:00
Own cheat sheets repository of the *cheat.sh*.
If you want to add a cheat sheet to cheat.sh directly,
add it here (please also consider adding your cheat sheet
to one of the upstream repositories).
When adding a cheat sheet please use the following format:
```
2020-11-12 10:08:03 +00:00
# Command name
# Short command description
# Command usage example1 started with some comments
# and followed with a command example/switches.
2017-05-08 20:33:58 +00:00
command1
2020-11-12 10:08:03 +00:00
# Command usage example2.
# Each block separated with an empty line.
2017-05-08 20:33:58 +00:00
command2
```
2020-11-12 10:08:03 +00:00
For example:
```
# curl
# Command-line tool for transferring data with URL syntax
# Process a single GET request, and show its output on stdout.
curl http://path.to.the/file
```
Requirements and constraints:
* Maximum length of a comment line (including comment sign) is 80
2020-11-12 16:24:22 +00:00
Other requirements can be proposed and discussed in [#101](https://github.com/chubin/cheat.sheets/issues/101)