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

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.