diff --git a/README.md b/README.md index 6bcedfe56..87389e14b 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,9 @@ 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. ``` -Surely people could benefit from simplified man pages focused on practical examples. How about: +Surely people could benefit from simplified man pages +focused on practical examples. +How about: ![tldr screenshot](screenshot.png) @@ -62,34 +64,58 @@ You can access these pages on your computer using one of the following clients: - Bash clients: - [tldr](https://github.com/raylee/tldr) - [tldr-bash-client](https://github.com/pepa65/tldr-bash-client) -- [C++ client](https://github.com/tldr-pages/tldr-cpp-client): `brew install tldr` -- [Crystal client](https://github.com/porras/tlcr): `brew install porras/tap/tlcr` -- [Dart client](https://github.com/hterkelsen/tldr): `pub global activate tldr` -- [Elixir client](https://github.com/edgurgel/tldr_elixir_client) (binaries not yet available) -- [Emacs client](https://github.com/kuanyui/tldr.el), available on [MELPA](https://github.com/melpa/melpa) +- [C++ client](https://github.com/tldr-pages/tldr-cpp-client): + `brew install tldr` +- [Crystal client](https://github.com/porras/tlcr): + `brew install porras/tap/tlcr` +- [Dart client](https://github.com/hterkelsen/tldr): + `pub global activate tldr` +- [Elixir client](https://github.com/edgurgel/tldr_elixir_client) + (binaries not yet available) +- [Emacs client](https://github.com/kuanyui/tldr.el), available on + [MELPA](https://github.com/melpa/melpa) - Go clients: - - [github.com/pranavraja/tldr](https://github.com/pranavraja/tldr): `go get github.com/pranavraja/tldr` (or [platform binaries](https://github.com/pranavraja/tldr/releases)) - - [4d63.com/tldr](https://4d63.com/tldr): `go get 4d63.com/tldr` or `brew install 4d63/tldr/tldr` (or [platform binaries](https://github.com/leighmcculloch/tldr/releases)) + - [github.com/pranavraja/tldr](https://github.com/pranavraja/tldr): + `go get github.com/pranavraja/tldr` + (or [platform binaries](https://github.com/pranavraja/tldr/releases)) + - [4d63.com/tldr](https://4d63.com/tldr): + `go get 4d63.com/tldr` or `brew install 4d63/tldr/tldr` + (or [platform binaries](https://github.com/leighmcculloch/tldr/releases)) - iOS clients: - - [tldr-man-page](https://github.com/freesuraj/TLDR), available on [App Store](https://appsto.re/sg/IQ0-_.i) - - [tldr-pages](https://github.com/mflint/ios-tldr-viewer), available on [App Store](https://itunes.apple.com/us/app/tldt-pages/id1071725095?ls=1&mt=8) -- [Haskell client](https://github.com/psibi/tldr-hs) : `stack install tldr` -- [Node.js client](https://github.com/tldr-pages/tldr-node-client) : `npm install -g tldr` -- [Perl5 client](https://github.com/shoichikaji/perl-tldr): `cpanm App::tldr` -- [PHP client](https://github.com/BrainMaestro/tldr-php): `composer global require brainmaestro/tldr` + - [tldr-man-page](https://github.com/freesuraj/TLDR), available on + [App Store](https://appsto.re/sg/IQ0-_.i) + - [tldr-pages](https://github.com/mflint/ios-tldr-viewer), available on + [App Store](https://itunes.apple.com/us/app/tldt-pages/id1071725095?ls=1&mt=8) +- [Haskell client](https://github.com/psibi/tldr-hs): + `stack install tldr` +- [Node.js client](https://github.com/tldr-pages/tldr-node-client): + `npm install -g tldr` +- [Perl5 client](https://github.com/shoichikaji/perl-tldr): + `cpanm App::tldr` +- [PHP client](https://github.com/BrainMaestro/tldr-php): + `composer global require brainmaestro/tldr` - Python clients: - - [tldr-python-client](https://github.com/tldr-pages/tldr-python-client) : `pip install tldr` - - [tldr.py](https://github.com/lord63/tldr.py): `pip install tldr.py` -- [R client](https://github.com/kirillseva/tldrrr): `devtools::install_github('kirillseva/tldrrr')` -- [Ruby client](https://github.com/YellowApple/tldrb): `gem install tldrb` + - [tldr-python-client](https://github.com/tldr-pages/tldr-python-client): + `pip install tldr` + - [tldr.py](https://github.com/lord63/tldr.py): + `pip install tldr.py` +- [R client](https://github.com/kirillseva/tldrrr): + `devtools::install_github('kirillseva/tldrrr')` +- [Ruby client](https://github.com/YellowApple/tldrb): + `gem install tldrb` - Rust clients: - - [rust-tldr](https://github.com/rilut/rust-tldr) (online lookup): `cargo install tldr` - - [tealdeer](https://github.com/dbrgn/tealdeer) (fully featured client with offline cache): `cargo install tealdeer` + - [rust-tldr](https://github.com/rilut/rust-tldr) + (thin client with online lookup): + `cargo install tldr` + - [tealdeer](https://github.com/dbrgn/tealdeer) + (fully featured client with offline cache): + `cargo install tealdeer` - Web clients: - [tldr.jsx](https://github.com/ostera/tldr.jsx): http://tldr.ostera.io/ - [DistroWatch](https://distrowatch.com/dwres.php?resource=man-pages) -There is also a comprehensive [list of clients in our Wiki](https://github.com/tldr-pages/tldr/wiki/TLDR-clients). +There is also a comprehensive +[list of clients in our Wiki](https://github.com/tldr-pages/tldr/wiki/TLDR-clients). ## Contributing @@ -102,17 +128,25 @@ Have a look at the [contributing guidelines](CONTRIBUTING.md), and go ahead! ## Similar projects -- [Cheat](https://github.com/chrisallenlane/cheat) allows you to create and view interactive cheatsheets on the command-line. - It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember. +- [Cheat](https://github.com/chrisallenlane/cheat) + allows you to create and view interactive cheatsheets on the command-line. + It was designed to help remind *nix system administrators of options + for commands that they use frequently, but not frequently enough to remember. -- [Bro pages](http://bropages.org/) are a highly readable supplement to man pages. +- [Bro pages](http://bropages.org/) + are a highly readable supplement to man pages. Bro pages show concise, common-case examples for Unix commands. - The examples are submitted by the user base, and can be voted up or down; the best entries are what people see first when they look up a command. - -- [eg](https://github.com/srsudar/eg) provides detailed examples with explanations on the command line. Examples come from the repository, but eg allows you to display custom examples and commands alongside the defaults. + The examples are submitted by the user base, and can be voted up or down; + the best entries are what people see first when they look up a command. + +- [eg](https://github.com/srsudar/eg) + provides detailed examples with explanations on the command line. + Examples come from the repository, but `eg` supports displaying + custom examples and commands alongside the defaults. ## 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 in the [TLDR article on Wikipedia](https://en.wikipedia.org/wiki/TL;DR). +It originates in Internet slang, where it is used to indicate that a long text +(or parts of it) has been skipped as too lengthy. +Read more in Wikipedia's [TL;DR article](https://en.wikipedia.org/wiki/TL;DR).