Home

Agniva De Sarker edited this page Jul 18, 2016 · 4 revisions

TLDR Pages

Simplified and community-driven man pages

Usage

Run in live demo or your terminal.

tldr tar

tldr tar command output

Installation

Install the NodeJS client

npm install -g tldr

You can also try other TLDR clients.

Contribute

Fork project's Github repo.

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.

License

MIT License