Skip to content

Commit f2a6a1b

Browse files
committed
README: update usage commands, fix Markdown
Signed-off-by: K.B.Dharun Krishna <[email protected]>
1 parent 56f9387 commit f2a6a1b

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,25 +46,24 @@ The default prefix for installation is `/usr/local/bin`.
4646

4747
Building the `tldr` client is pretty straightforward.
4848

49-
#### Requirements
49+
### Requirements
5050

5151
- `clang`/`gcc`
5252
- `libcurl` (`brew install curl` / `apt-get install libcurl-dev` / `apt-get install libcurl4-openssl-dev`)
5353
- `libzip` (`brew install libzip` / `apt-get install libzip-dev`)
5454
- `pkg-config` (`brew install pkg-config` / `apt-get install pkg-config`)
5555

56-
#### Compiling
56+
### Compiling
5757

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

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

63-
```
63+
```shell
6464
make
6565
```
6666

67-
6867
## Autocompletion
6968

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

76-
#### Installation
75+
### Installation
7776

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

88-
8987
## Usage
9088

91-
```
92-
usage: ./tldr [-v] [OPTION]... SEARCH
89+
```shell
90+
usage: tldr [-v] [OPTION]... SEARCH
9391

9492
available commands:
95-
-v print verbose output
96-
--version print version and exit
97-
-h, --help print this help and exit
98-
-u, --update update local database
99-
-c, --clear-cache clear local database
100-
-p, --platform=PLATFORM select platform, supported are linux / osx / sunos / common
93+
-v print verbose output
94+
--version print version and exit
95+
-h, --help print this help and exit
96+
-u, --update update local database
97+
-c, --clear-cache clear local database
98+
-l, --list list all entries in the local database
99+
-p, --platform=PLATFORM select platform, supported are linux / osx / sunos / windows / common
100+
--linux show command page for Linux
101+
--osx show command page for OSX
102+
--sunos show command page for SunOS
101103
-r, --render=PATH render a local page for testing purposes
104+
-C, --color force color display
102105
```
103106
104107
## Configuration

0 commit comments

Comments
 (0)