New README & CONTRIBUTING that apply to pages only
This commit is contained in:
36
README.md
Normal file
36
README.md
Normal 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:
|
||||
|
||||

|
||||
|
||||
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)
|
||||
|
||||
[](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.
|
Reference in New Issue
Block a user