tldr-pages/tldr
1
1
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2024-10-03 23:07:10 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

Owen Voke 2019-05-28 13:49:58 +01:00
parent 42ce5d1369
commit 8ea57b99ff
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Home.md

@ -4,7 +4,7 @@
## Usage
Run in [live demo](https://tldr.ostera.io) or your terminal.
View the [live demo](https://tldr.ostera.io) or run the command from your terminal.
~~~shell
tldr tar
@ -14,7 +14,7 @@ tldr tar
## Installation
Install the NodeJS client
Install the NodeJS client:
~~~shell
npm install -g tldr
@ -24,21 +24,21 @@ You can also try [[other TLDR clients|TLDR-clients]].
## Contribute
Fork project's [Github repo](https://github.com/tldr-pages/tldr).
Fork the project's [Github repository](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.
Just edit any pages from the `pages/` directory and submit a pull request.
Best practices:
- Focus on the 5-6 most common usages.
- Focus on up to 8 of the 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.
- Have a look at a few existing pages if you need any help.
Check more detailed [Contributing Guidelines](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md).
Check out the more detailed [Contributing Guidelines](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md).
## License