tldr-pages/tldr
1
1
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2024-11-24 12:56:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

cleanup: update installation section to match with repo README

K.B.Dharun Krishna 2024-02-19 19:20:06 +05:30
parent a13a16d04f
commit c1b1f555ff
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Home.md

@ -12,27 +12,40 @@ tldr tar
![tldr tar command output](https://raw.githubusercontent.com/tldr-pages/tldr/main/images/tldr-dark.png)
## Installation
## How do I use it?
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:
> [!TIP]
> For browsing without installing a client on your computer,
> see the web client at <https://tldr.inbrowser.app> (with offline support using PWA).
A popular and convenient way to access these pages on your computer
is to install the official [Node.js client](https://github.com/tldr-pages/tldr-node-client):
```shell
npm install -g tldr
```
Alternatively, you can also use the official [Python client](https://github.com/tldr-pages/tldr-python-client), which can be installed via [pip3](https://pypi.org/project/tldr/).
Alternatively, you can also use the official [Python client](https://github.com/tldr-pages/tldr-python-client), which can be installed via [pip3](https://pypi.org/project/tldr/) (or [other package managers](https://github.com/tldr-pages/tldr-python-client#installation)):
```shell
pip3 install tldr
```
Or Linux and Mac users can also install the official [Rust Client](https://github.com/tldr-pages/tlrc) using [Homebrew](https://formulae.brew.sh/formula/tlrc):
Linux and Mac users can also install the official [Rust Client](https://github.com/tldr-pages/tlrc) using [Homebrew](https://formulae.brew.sh/formula/tlrc) (or [other package managers](https://github.com/tldr-pages/tlrc#installation) on other operating systems):
```shell
brew install tlrc
```
You can also try [[other tldr pages clients|tldr pages clients]].
Then you have direct access to simplified, easy-to-read help for commands, such as `tar`,
accessible through typing `tldr tar` instead of the standard `man tar`.
If you don't want to install any software,
check out the [PDF version](https://tldr.sh/assets/tldr-book.pdf).
There are also **various other clients** provided by the community,
both for the command line and for other platforms.
For a comprehensive list of clients, head over to our [Wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients).
## Contribute