mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-11-28 05:22:25 +03:00
Initial Home page
commit
0fda57533d
58
Home.md
Normal file
58
Home.md
Normal file
@ -0,0 +1,58 @@
|
||||
# TLDR Pages
|
||||
|
||||
> Simplified and community-driven man pages
|
||||
|
||||
## Usage
|
||||
|
||||
Run in [live demo](https://ostera.github.io/tldr.js) or your terminal.
|
||||
|
||||
~~~shell
|
||||
tldr tar
|
||||
~~~
|
||||
|
||||
![tldr tar command output](http://tldr-pages.github.io/images/screenshot.png?s=200)
|
||||
|
||||
## Installation
|
||||
|
||||
Install the NodeJS client
|
||||
|
||||
~~~shell
|
||||
npm install -g tldr
|
||||
~~~
|
||||
|
||||
You can also try other TLDR clients
|
||||
|
||||
Client | Installation instruction
|
||||
----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------
|
||||
[Web client](https://github.com/ostera/tldr.js) | try tldr on your browser [here](https://ostera.github.io/tldr.js)!
|
||||
[Node.js client](https://github.com/tldr-pages/tldr-node-client) | ```npm install -g tldr```
|
||||
[Ruby client](https://github.com/YellowApple/tldrb) | ```gem install tldrb```
|
||||
[Python client](https://github.com/lord63/tldr.py) | ```pip install tldr.py```
|
||||
[C++ client](https://github.com/tldr-pages/tldr-cpp-client) | ```brew tap tldr-pages/tldr``` <br> ```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)
|
||||
|
||||
There are more clients listed in [README.md]({{ site.github }}/blob/master/README.md#clients).
|
||||
|
||||
|
||||
## Contribute
|
||||
|
||||
Fork project's [Github repo](https://github.com/tldr-pages/tldr).
|
||||
|
||||
This repository is just that: an ever-growing collection of examples for the most common UNIX / Linux / OSX / SunOS commands.
|
||||
|
||||
Just edit some page from `pages/` folder and submit a pull request.
|
||||
|
||||
Best practices:
|
||||
|
||||
- Focus on the 5-6 most common usages.
|
||||
- When in doubt, keep new command-line users in mind.
|
||||
- Introduce examples gradually, from the simplest to more complex.
|
||||
- Don't explain general UNIX concepts.
|
||||
- Have a look at a few existing pages.
|
||||
|
||||
Check more detailed [Contributing Guidelines](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md/blob/master/CONTRIBUTING.md).
|
||||
|
||||
|
||||
## License
|
||||
|
||||
[MIT License]({{site.github}}/blob/master/LICENSE.md)
|
Loading…
Reference in New Issue
Block a user