Robot
/
tldr-bash-client
mirror of https://github.com/pepa65/tldr-bash-client.git
2
0
Fork 0
Code Issues Releases Wiki Activity

Adapted readme to the only way to control image width

This commit is contained in:
pepa65 2017-02-06 10:26:01 +07:00
parent 8ede6090cc
commit 04a45d1e46
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -4,9 +4,9 @@
client for the [tldr](https://github.com/rprieto/tldr/) project, providing
poignant examples of terminal commands.**
![tldr list screenshot](tldr-list.jpg?raw=true "tldr list" = 400x)
<img alt="tldr list screenshot" src="tldr-list.jpg" title="tldr list" width="600" />
<img alt="tldr page screenshot" src="tldr-page.jpg" title="tldr page" width="400" />
<img alt="tldr page screenshot" src="tldr-page.jpg" title="tldr page" width="600" />
## Installation
Download the tldr bash script to the install location:
@ -22,7 +22,7 @@ If the location is not in $PATH, you need to specify the path to run it.
### Prerequisites
coreutils, less, grep, unzip, curl / wget
![tldr usage screenshot](tldr-usage.jpg?raw=true "tldr usage" | width=400)
<img alt="tldr usage screenshot" src="tldr-usage.jpg" title="tldr usage" width="600" />
## Customisation
The colors and other styling of the 5 elements of tldr pages can be modified
@ -39,13 +39,14 @@ Also the error color and page expiry can easily be set:
* TLDR_EXPIRY (defaults to: 60)
![tldr customize screenshot](tldr-customize.jpg?raw=true "tldr customize" {width:400px})
<img alt="tldr customize screenshot" src="tldr-customize.jpg" title="tldr customize" width="600" />
## Contributing
Please file an issue for a question, a bug or a feature request.
Or even better, send a pull request!
![tldr markdown screenshot](tldr-markdown.jpg?raw=true "tldr markdown" {width=400px})
<img alt="tldr markdown screenshot" src="tldr-markdown.jpg" title="tldr markdown" width="600" />
### License