mirror of
https://github.com/Erreur32/cheat.git
synced 2024-12-22 21:52:12 +01:00
CONTRIBUTING.md
Put some useful information in `CONTRIBUTING.md`.
This commit is contained in:
parent
8019325f1e
commit
b9241efab1
1 changed files with 15 additions and 7 deletions
|
@ -3,15 +3,23 @@ Contributing
|
||||||
If you would like to contribute cheetsheets or program functionality, please
|
If you would like to contribute cheetsheets or program functionality, please
|
||||||
fork this repository, make your changes, and submit a pull request.
|
fork this repository, make your changes, and submit a pull request.
|
||||||
|
|
||||||
|
|
||||||
|
## Python standards ##
|
||||||
Python code should conform to [PEP 8][].
|
Python code should conform to [PEP 8][].
|
||||||
|
|
||||||
Licensing
|
|
||||||
---------
|
|
||||||
By contributing to the project, you agree to license your work under the same
|
|
||||||
licenses as `cheat` itself. `cheat` is currently dual-licensed under the GPL3
|
|
||||||
and MIT licenses, though that could change without notice in the future.
|
|
||||||
|
|
||||||
`cheat`, however, will always remain free software (as in both "free as in
|
## Cheatsheet Format ##
|
||||||
freedom" and "free as in beer") and shall always be licensed accordingly.
|
Please pattern your cheatsheets after the following:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# To extract an uncompressed archive:
|
||||||
|
tar -xvf /path/to/foo.tar
|
||||||
|
|
||||||
|
# To create an uncompressed archive:
|
||||||
|
tar -cvf /path/to/foo.tar /path/to/foo/
|
||||||
|
|
||||||
|
# To extract a .gz archive:
|
||||||
|
tar -xzvf /path/to/foo.tgz
|
||||||
|
```
|
||||||
|
|
||||||
[PEP 8]: http://legacy.python.org/dev/peps/pep-0008/
|
[PEP 8]: http://legacy.python.org/dev/peps/pep-0008/
|
||||||
|
|
Loading…
Reference in a new issue