From c1b1f555ff3f7204de203dbc4abb2192f50784eb Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 19 Feb 2024 19:20:06 +0530 Subject: [PATCH] cleanup: update installation section to match with repo README --- Home.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/Home.md b/Home.md index 2ae2dca..07aaa05 100644 --- a/Home.md +++ b/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 (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