lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-29 23:24:55 +02:00
Code Activity

depersonalize, and other minor tweaks

Browse source
This commit is contained in:
Waldir Pimenta 2015-12-27 23:40:21 +00:00
parent 9dde2b4bfc
commit 4536ac599f
1 changed files with 18 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -10,12 +10,14 @@
*tldr* is a collection of simplified and community-driven man pages.
## What does tldr mean?
TL;DR stands for Too Long; Didn't Read. It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy. Read more on [TLDR page from Wikipedia](https://en.wikipedia.org/wiki/TL;DR).
TL;DR stands for "Too Long; Didn't Read".
It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy.
Read more in the [TLDR article on Wikipedia](https://en.wikipedia.org/wiki/TL;DR).
## What is tldr?
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`?
Or perhaps 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:
@ -26,11 +28,13 @@ Maybe it doesn't help that the first option explained in `man tar` is:
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:
Surely people could benefit from simplified "show me the common usages" man pages. What about:
![tldr screenshot](http://raw.github.com/tldr-pages/tldr/master/screenshot.png)
This repository is just that: an ever-growing collection of examples for the most common UNIX / Linux / OSX / SunOS commands.
This repository is just that:
an ever-growing collection of examples
for the most common UNIX / Linux / OSX / SunOS commands.
## Clients
@ -39,18 +43,23 @@ You can access these pages on your computer using one of the following clients:
- [Node.js client](https://github.com/tldr-pages/tldr-node-client) : `npm install -g tldr`
- [Python client](https://github.com/tldr-pages/tldr-python-client) : `pip install tldr`
- [Python client](https://github.com/lord63/tldr.py): `pip install tldr.py`
- [Go client](https://github.com/pranavraja/tldr) : `go get github.com/pranavraja/tldr` or [platform binaries](https://github.com/pranavraja/tldr/releases)
- [Go client](https://github.com/pranavraja/tldr): `go get github.com/pranavraja/tldr`
or [platform binaries](https://github.com/pranavraja/tldr/releases)
- [Elixir client](https://github.com/tldr-pages/tldr_elixir_client): binaries available soon
- [C++ client](https://github.com/tldr-pages/tldr-cpp-client): `brew tap tldr-pages/tldr && brew install tldr`
- [Android client](https://github.com/gianasista/tldr-viewer): available on [Google Play](https://play.google.com/store/apps/details?id=de.gianasista.tldr_viewer)
- [Android client](https://github.com/gianasista/tldr-viewer): available on
[Google Play](https://play.google.com/store/apps/details?id=de.gianasista.tldr_viewer)
- [Ruby client](https://github.com/YellowApple/tldrb): `gem install tldrb`
- [Web client](https://github.com/ostera/tldr.js): try tldr on your browser [here](https://ostera.github.io/tldr.js)!
- [Web client](https://github.com/ostera/tldr.js): try tldr on your browser
[here](https://ostera.github.io/tldr.js)!
Let us know if you are building one and we can add it to this list!
## Contributing
- Your favourite command isn't covered?
- You can think of more examples?
- You can think of more examples for an existing command?
Contribution are most welcome! Have a look here for some rough [contributing guidelines](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md).
Contributions are most welcome!
Have a look at the [contributing guidelines](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md)
and go ahead!