New README & CONTRIBUTING that apply to pages only

This commit is contained in:
rprieto 2014-03-04 23:39:34 +11:00
parent 6c6ec8f923
commit 8d6fa5235c
5 changed files with 134 additions and 0 deletions

12
.editorconfig Normal file
View File

@ -0,0 +1,12 @@
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false

65
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,65 @@
# 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?

21
LICENSE.md Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2014 Romain Prieto
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# What is this?
New to the command-line world? Or just a little rusty?
Or, like me, you can't always remember the arguments to `lsof` or `tar`?
Maybe it doesn't help that the first option explained in `man tar` is:
```
-b blocksize
Specify the block size, in 512-byte records, for tape drive I/O.
As a rule, this argument is only needed when reading from or writing to tape drives,
and usually not even then as the default block size of 20 records (10240 bytes) is very common.
```
I'm sure people could benefit from simplified "show me the common usages" man pages. What about:
![tldr screenshot](http://raw.github.com/rprieto/tldr/master/screenshot.png)
This repository is just that: an ever-growing collection of examples for the most common UNIX / Linux / OSX / SunOS commands.
## Clients
You can access these pages on your computer using one of the following clients:
- [Node.js client](https://github.com/rprieto/tldr-node-client)
[![NPM](https://nodei.co/npm/tldr.png)](https://www.npmjs.org/package/tldr)
There are other clients in the works... let us know if you built one and we can add it to this list!
## Contributing
- Your favourite command isn't covered?
- You can think of more examples?
Contribution are most welcome! Have a look [over here](https://github.com/rprieto/tldr/blob/master/CONTRIBUTING.md) for some rough guidelines.

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB