You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
# cheat.sheets
|
|
|
|
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:
|
|
|
|
```
|
|
# Command name
|
|
# Short command description
|
|
|
|
# Command usage example1 started with some comments
|
|
# and followed with a command example/switches.
|
|
command1
|
|
|
|
# Command usage example2.
|
|
# Each block separated with an empty line.
|
|
command2
|
|
```
|
|
|
|
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
|
|
|
|
Other requirements can be proposed and discussed in [#101](https://github.com/chubin/cheat.sheets/issues/101)
|
|
|
|
|
|
## Getting started
|
|
|
|
If you are new to Github, and you want to contribute to cheat.sheets, you can start from this video:
|
|
|
|
* [How to contribute to cheat.sheets](https://www.youtube.com/watch?v=ZJ3lPQVoiVw) — a short introduction into Github and the cheat.sheets repository
|