mirror of https://github.com/CrimsonTome/tldr.git
66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
- Your favourite command isn't covered?
|
||
|
|
- You can think of more examples?
|
||
|
|
|
||
|
|
Contribution are most welcome! All `tldr` pages are stored in Markdown right here on GitHub. Just open an issue or send a pull request and we'll merge it as soon as possible.
|
||
|
|
|
||
|
|
## Guidelines
|
||
|
|
|
||
|
|
Note that `tldr` is focussed on concrete examples.
|
||
|
|
Here's a few guidelines to get started:
|
||
|
|
|
||
|
|
- Focus on the 5 or 6 most common usages
|
||
|
|
- When in doubt, keep new command-line users in mind
|
||
|
|
- It's OK if the page doesn't cover everything, that's what `man` is for
|
||
|
|
|
||
|
|
Token formatting:
|
||
|
|
|
||
|
|
- Highlight user-provided values using the `{{token}}` syntax (e.g. `tar cf {{my_file}}`)
|
||
|
|
- For consistency, use plain text description for the tokens (`source_file` instead of `../my/awesome/example`)
|
||
|
|
|
||
|
|
Common pitfalls / "donts"
|
||
|
|
|
||
|
|
- Don't try to cover all possible examples, or combinations of flags (often, this is not possible without looking like `man`)
|
||
|
|
- Don't explain general UNIX concepts that could apply to any command (ex: relative/absolute paths, brace expansion...)
|
||
|
|
- Avoid catch-all examples like `tar {{options}}`
|
||
|
|
- Don't group options as a trick to keep pages short (`tar {{c or x}}`)
|
||
|
|
|
||
|
|
The best way to be consistent is to have a look at a few existing pages :)
|
||
|
|
|
||
|
|
## Markdown format
|
||
|
|
|
||
|
|
For now, the format of each page has to match the following:
|
||
|
|
|
||
|
|
```
|
||
|
|
# command-name
|
||
|
|
|
||
|
|
> Short description
|
||
|
|
> Max 1 or 2 lines
|
||
|
|
|
||
|
|
- example description
|
||
|
|
|
||
|
|
`command -arg1 -arg2`
|
||
|
|
|
||
|
|
- example description
|
||
|
|
|
||
|
|
`command -arg1 -arg2`
|
||
|
|
```
|
||
|
|
|
||
|
|
Eventually we might relax the format to accept any Markdown, but for now this has the advantage of adding some consitency between all pages, and making sure we focus on concrete examples rather than lengthy explanation of the different flags.
|
||
|
|
|
||
|
|
In the odd case you need a few examples grouped together, the convention so far is:
|
||
|
|
|
||
|
|
```
|
||
|
|
- example description
|
||
|
|
|
||
|
|
`command -arg1`
|
||
|
|
`command -arg2`
|
||
|
|
```
|
||
|
|
|
||
|
|
---------------------------------------
|
||
|
|
|
||
|
|
**Footnote:** tldr is under MIT license.
|
||
|
|
|
||
|
|
You're free to modify or redistribute the content. That being said, but why not contribute over here? :) Say if you wanted to have `tldr` pages in `groff` format, why not have a client that uses [pandoc](http://johnmacfarlane.net/pandoc/) and periodically updates straight from this repo?
|