diff --git a/README.md b/README.md index 6a3916fa8c..1dd22126d3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# tldr +
+

tldr-pages

[![Build status][travis-image]][travis-url] [![Gitter chat][gitter-image]][gitter-url] @@ -13,24 +14,24 @@ [gitter-image]: https://badges.gitter.im/tldr-pages/tldr.svg [prs-merged-url]: https://github.com/tldr-pages/tldr/pulls?q=is:pr+is:merged [prs-merged-image]: https://img.shields.io/github/issues-pr-closed-raw/tldr-pages/tldr.svg?label=merged+PRs -[issuestats-url]: http://isitmaintained.com/project/tldr-pages/tldr -[issuestats-image]: http://isitmaintained.com/badge/resolution/tldr-pages/tldr.svg +[issuestats-url]: https://isitmaintained.com/project/tldr-pages/tldr +[issuestats-image]: https://isitmaintained.com/badge/resolution/tldr-pages/tldr.svg [contributors-url]: https://github.com/tldr-pages/tldr/graphs/contributors [contributors-image]: https://img.shields.io/github/contributors/tldr-pages/tldr.svg [license-url]: https://github.com/tldr-pages/tldr/blob/master/LICENSE.md [license-image]: https://img.shields.io/badge/license-CC%20BY%204.0-lightgrey.svg - -A collection of simplified and community-driven man pages. - -Install it with `npm install -g tldr` -or [try the web client](http://tldr.ostera.io). +
## What is tldr-pages? -New to the command-line world? Or just a little rusty? +The **tldr-pages** project is a collection of community-maintained help pages +for command-line tools, that aims to be a simpler, more approachable complement +to traditional [man pages](https://en.wikipedia.org/wiki/Man_page). + +Maybe you are new to the command-line world? Or just a little rusty? Or perhaps you can't always remember the arguments to `lsof`, or `tar`? -Maybe it doesn't help that the first option explained in `man tar` is: +It certainly doesn't help that the first option explained in `man tar` is: ``` -b blocksize @@ -39,18 +40,27 @@ 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. +There seems to be room for simpler help pages, focused on practical examples. How about: ![screenshot of the tldr-node-client displaying the tldr page for the tar command](images/screenshot.png) This repository is just that: an ever-growing collection of examples -for the most common UNIX, Linux, macOS, SunOS and Windows commands. +for the most common UNIX, Linux, macOS, SunOS and Windows command-line tools. -## Clients +## How do I use it? -You can access these pages on your computer using one of the following clients: +A popular and convenient way to access these pages on your computer +is to install the [Node.js client](https://github.com/tldr-pages/tldr-node-client), +which is supported by the tldr-pages project maintainers: + + npm install -g tldr + +That way you can write `tldr tar` in the terminal to show the tldr page for `tar`, +just like you would write `man tar` to show its manpage. + +There are also various other clients provided by the community, +both for the command line and for other platforms: - [Alfred Workflow](https://github.com/cs1707/tldr-alfred) - [Albert Plugin](https://github.com/bergercookie/awesome-albert-plugins/tree/master/plugins/tldr_pages) @@ -128,12 +138,15 @@ You can access these pages on your computer using one of the following clients: There is also a comprehensive [list of clients in our Wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients). -## Contributing +## How do I contribute? - Your favourite command isn't covered? - You can think of more examples for an existing command? -Contributions are most welcome! +All `tldr` pages are kept as markdown files right here in this repository, +so you can edit them directly and submit your changes as pull requests. + +All contributions are welcome! We strive to maintain a [welcoming and collaborative](GOVERNANCE.md) community. Have a look at the [contributing guidelines](CONTRIBUTING.md), and go ahead! diff --git a/images/banner-light.png b/images/banner-light.png new file mode 100644 index 0000000000..47031391f7 Binary files /dev/null and b/images/banner-light.png differ diff --git a/images/banner.png b/images/banner.png index 27444ec586..e4542f8131 100644 Binary files a/images/banner.png and b/images/banner.png differ diff --git a/images/banner.svg b/images/banner.svg index 4d8cfd57a6..b795640da4 100644 --- a/images/banner.svg +++ b/images/banner.svg @@ -1,4 +1,4 @@ - + @@ -22,7 +22,7 @@ - + @@ -31,16 +31,11 @@ - + tldr-pages - - - A collection of simplified, - - - community-driven man pages. - + + collaborative cheatsheets for console commands diff --git a/pages/common/tldr.md b/pages/common/tldr.md index 2379f45af6..f9cc68100e 100644 --- a/pages/common/tldr.md +++ b/pages/common/tldr.md @@ -1,7 +1,6 @@ # tldr -> Command-line client for tldr-pages. -> Displays simplified and community-driven man pages. +> Displays simple help pages for command-line tools, from the tldr-pages project. > More information: . - Get typical usages of a command (hint: this is how you got here!):