From 28d191d4cb06c06c92bf4d01796c46c55556c577 Mon Sep 17 00:00:00 2001 From: Leandro Ostera Date: Sat, 6 Feb 2016 12:23:19 +0100 Subject: [PATCH 1/3] Add tldr for installing or trying right on top. Also moves what is TL;DR to the bottom, since it's more of a miscellanea. --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 838c0cefb..22dba0085 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,9 @@ [gitter-url]: https://gitter.im/tldr-pages/tldr [gitter-image]: https://img.shields.io/gitter/room/tldr-pages/tldr.svg -*tldr* is a collection of simplified and community-driven man pages. +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 in the [TLDR article on Wikipedia](https://en.wikipedia.org/wiki/TL;DR). +Install it with `npm install -g tldr` or [try the web client](https://ostera.github.io/tldr.jsx). ## What is tldr? @@ -86,3 +83,9 @@ and go ahead! - [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 show concise, common-case examples for Unix commands. + +## 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). From a420204f25cc30e42811b9771b6f61e01e281224 Mon Sep 17 00:00:00 2001 From: Leandro Ostera Date: Sat, 6 Feb 2016 12:24:17 +0100 Subject: [PATCH 2/3] Sorted clients by platform. --- README.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 22dba0085..0cf37b4cc 100644 --- a/README.md +++ b/README.md @@ -37,35 +37,32 @@ for the most common UNIX / Linux / OSX / SunOS commands. 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 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` -- [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 not yet available) -- [C++ client](https://github.com/tldr-pages/tldr-cpp-client): `brew install tldr-pages/tldr/tldr` - Android clients: - [tldr-viewer](https://github.com/gianasista/tldr-viewer), available on [Google Play](https://play.google.com/store/apps/details?id=de.gianasista.tldr_viewer) - [tldroid](https://github.com/hidroh/tldroid), available on [Google Play](https://play.google.com/store/apps/details?id=io.github.hidroh.tldroid) +- [Bash client](https://github.com/raylee/tldr) +- [C++ client](https://github.com/tldr-pages/tldr-cpp-client): `brew install tldr-pages/tldr/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/tldr-pages/tldr_elixir_client) (binaries not yet available) +- [Emacs client](https://github.com/kuanyui/tldr.el) - 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/tldr-pages/id1071725095?ls=1&mt=8) + - [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) +- [Go client](https://github.com/pranavraja/tldr): `go get github.com/pranavraja/tldr` (or [platform binaries](https://github.com/pranavraja/tldr/releases)) +- [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` +- 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` - Rust clients: - [rust-tldr](https://github.com/rilut/rust-tldr) (online lookup): `cargo install tldr` - [tldr-rs](https://github.com/dbrgn/tldr-rs) (offline caching, not yet published) -- [R client](https://github.com/kirillseva/tldrrr): `devtools::install_github('kirillseva/tldrrr')` -- [Dart client](https://github.com/hterkelsen/tldr): `pub global activate tldr` - [Web client](https://github.com/ostera/tldr.jsx): https://ostera.github.io/tldr.jsx -- [Perl5 client](https://github.com/shoichikaji/perl-tldr): `cpanm App::tldr` -- [Emacs client](https://github.com/kuanyui/tldr.el) -- [Bash client](https://github.com/raylee/tldr) -- [Crystal client](https://github.com/porras/tlcr): `brew install porras/tap/tlcr` There is also a comprehensive [list of clients in Wiki](https://github.com/tldr-pages/tldr/wiki/TLDR-clients). From 18ccbbc644ab3e2d274086fb2a558504e3d7cb7c Mon Sep 17 00:00:00 2001 From: Leandro Ostera Date: Sat, 6 Feb 2016 12:26:18 +0100 Subject: [PATCH 3/3] Oops! g comes before i :P --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0cf37b4cc..1de120b87 100644 --- a/README.md +++ b/README.md @@ -48,10 +48,10 @@ You can access these pages on your computer using one of the following clients: - [Dart client](https://github.com/hterkelsen/tldr): `pub global activate tldr` - [Elixir client](https://github.com/tldr-pages/tldr_elixir_client) (binaries not yet available) - [Emacs client](https://github.com/kuanyui/tldr.el) +- [Go client](https://github.com/pranavraja/tldr): `go get github.com/pranavraja/tldr` (or [platform binaries](https://github.com/pranavraja/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) -- [Go client](https://github.com/pranavraja/tldr): `go get github.com/pranavraja/tldr` (or [platform binaries](https://github.com/pranavraja/tldr/releases)) - [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` - Python clients: @@ -64,7 +64,7 @@ You can access these pages on your computer using one of the following clients: - [tldr-rs](https://github.com/dbrgn/tldr-rs) (offline caching, not yet published) - [Web client](https://github.com/ostera/tldr.jsx): https://ostera.github.io/tldr.jsx -There is also a comprehensive [list of clients in 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