Skip to content

Commit

Permalink
README: update usage commands, fix Markdown
Browse files Browse the repository at this point in the history
Signed-off-by: K.B.Dharun Krishna <[email protected]>
  • Loading branch information
kbdharun committed Oct 14, 2023
1 parent a33bde9 commit ed79364
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,25 +46,24 @@ The default prefix for installation is `/usr/local/bin`.

Building the `tldr` client is pretty straightforward.

#### Requirements
### Requirements

- `clang`/`gcc`
- `libcurl` (`brew install curl` / `apt-get install libcurl-dev` / `apt-get install libcurl4-openssl-dev`)
- `libzip` (`brew install libzip` / `apt-get install libzip-dev`)
- `pkg-config` (`brew install pkg-config` / `apt-get install pkg-config`)

#### Compiling
### Compiling

The [`Makefile`](https://github.com/tldr-pages/tldr-c-client/blob/master/Makefile)
in the root directory has all you need for building the project.

Just call `make` and `tldr` will build itself.

```
```shell
make
```


## Autocompletion

Autocompletion is supported for `bash`, `zsh`, and `fish` and can be added by sourcing
Expand All @@ -73,7 +72,7 @@ the correct autocompletion file.
The files `autocomplete.zsh`, `autocomplete.bash`, and `autocomplete.fish` can be found in the `autocomplete`
folder in the root of the repository.

#### Installation
### Installation

To install the autocompletion, just move the script for your shell to an easy
to access the directory (like your home directory), and source it in your `.bashrc` or `.zshrc`.
Expand All @@ -85,20 +84,24 @@ mv autocomplete/complete.zsh ~/.tldr.complete
echo "source ~/.tldr.complete" >> ~/.zshrc
```


## Usage

```
usage: ./tldr [-v] [OPTION]... SEARCH
```shell
usage: tldr [-v] [OPTION]... SEARCH

available commands:
-v print verbose output
--version print version and exit
-h, --help print this help and exit
-u, --update update local database
-c, --clear-cache clear local database
-p, --platform=PLATFORM select platform, supported are linux / osx / sunos / common
-v print verbose output
--version print version and exit
-h, --help print this help and exit
-u, --update update local database
-c, --clear-cache clear local database
-l, --list list all entries in the local database
-p, --platform=PLATFORM select platform, supported are linux / osx / sunos / windows / common
--linux show command page for Linux
--osx show command page for OSX
--sunos show command page for SunOS
-r, --render=PATH render a local page for testing purposes
-C, --color force color display
```
## Configuration
Expand Down

0 comments on commit ed79364

Please sign in to comment.