Skip to content

Commit 134df40

Browse files
authored
README: minor fixes, document make uninstall
1 parent 7c16e9a commit 134df40

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,12 @@
44

55
A command line client for tldr, written in plain ISO C90.
66

7-
87
## Installing
98

109
On OS X, the client can be installed through [Homebrew](http://brew.sh/).
1110

1211
```shell
13-
# To install latest development version
12+
# To install the latest development version
1413
brew install tldr --HEAD
1514

1615
# To install the latest stable release
@@ -23,15 +22,21 @@ On Arch Linux, the client can be installed through [the AUR](https://aur.archlin
2322
yay -S tldr-git
2423
```
2524

26-
To build the latest version from source:
25+
To build the latest version from the source:
2726

2827
```shell
2928
git clone https://github.com/tldr-pages/tldr-c-client.git
3029
cd tldr-c-client
3130

32-
./deps.sh # install dependencies
31+
sudo ./deps.sh # install dependencies
3332
make # build tldr
34-
make install # install tldr
33+
sudo make install # install tldr
34+
```
35+
36+
To remove the version installed from the source:
37+
38+
```shell
39+
sudo make uninstall
3540
```
3641

3742
The default prefix for installation is `/usr/local/bin`.
@@ -51,7 +56,7 @@ Building the `tldr` client is pretty straightforward.
5156
#### Compiling
5257

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

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

@@ -71,7 +76,7 @@ folder in the root of the repository.
7176
#### Installation
7277

7378
To install the autocompletion, just move the script for your shell to an easy
74-
to access directory (like your home directory), and source it in your `.bashrc` or `.zshrc`.
79+
to access the directory (like your home directory), and source it in your `.bashrc` or `.zshrc`.
7580

7681
Example for zsh:
7782

@@ -104,7 +109,6 @@ To prevent `tldr` from automatically updating its database, set the environment
104109

105110
Please read the [CONTRIBUTING.md](https://github.com/tldr-pages/tldr-c-client/blob/master/CONTRIBUTING.md) for details.
106111

107-
108112
## License
109113

110114
The MIT License (MIT) - see [LICENSE](https://github.com/tldr-pages/tldr-c-client/blob/master/LICENSE) for details.

0 commit comments

Comments
 (0)