Browse Source

Update project motto and improve README

Waldir Pimenta 4 years ago
parent
commit
524d44eb13
5 changed files with 36 additions and 29 deletions
  1. 30 17
      README.md
  2. BIN
      images/banner-light.png
  3. BIN
      images/banner.png
  4. 5 10
      images/banner.svg
  5. 1 2
      pages/common/tldr.md

+ 30 - 17
README.md

@@ -1,4 +1,5 @@
-# tldr
+<div align="center">
+<h1><img alt="tldr-pages" src="images/banner-light.png" width=600/></h1>
 
 [![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).
+</div>
 
 ## 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.
+
+## How do I use it?
 
-## 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:
 
-You can access these pages on your computer using one of the following clients:
+    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!
 

BIN
images/banner-light.png


BIN
images/banner.png


+ 5 - 10
images/banner.svg

@@ -1,4 +1,4 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="2200" height="1000">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="2000" height="1200">
   <defs>
     <linearGradient id="a">
       <stop offset="0" stop-color="#97d6d2"/>
@@ -22,7 +22,7 @@
   </defs>
   <rect width="100%" height="100%" x="0" y="0" fill="#203050"/>
   <!-- start of logo.svg -->
-  <g transform="translate(100,100)">
+  <g transform="translate(600,-70)"><!-- 2000/2 - 460/2 - 170 = 1000 - 230 - 170 = 1000 - 400 = 600 -->
     <rect width="460" height="460" x="170" y="170" rx="50" ry="50" fill="url(#b)"/>
     <rect width="380" height="380" x="210" y="210" rx="40" ry="40" fill="url(#c)"/>
     <text x="215" y="490" font-size="300" font-family="Sometype Mono, monospace" fill="#203050">
@@ -31,16 +31,11 @@
   </g>
   <!-- end of logo.svg -->
   <g fill="#7ebfb7" font-family="Sometype Mono, monospace">
-    <text x="840" y="480" font-size="170" font-weight="bold" transform="scale(1, 0.9)">
+    <text x="1000" y="850" font-size="280" font-weight="bold" text-anchor="middle">
       tldr-pages
     </text>
-    <text font-size="62" font-weight="500">
-      <tspan x="860" y="580">
-        A collection of simplified,
-      </tspan>
-      <tspan x="860" y="670">
-        community-driven man pages.
-      </tspan>
+    <text x="1000" y="1070" font-size="75" font-weight="500" text-anchor="middle" font-variant="small-caps">
+      collaborative cheatsheets for console commands
     </text>
   </g>
 </svg>

+ 1 - 2
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: <https://tldr.sh>.
 
 - Get typical usages of a command (hint: this is how you got here!):