Skip to content

Commit

Permalink
Added more details to the installation description
Browse files Browse the repository at this point in the history
  • Loading branch information
mhahnFr committed Sep 11, 2024
1 parent f990659 commit 448d5a2
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,30 @@ Or in one step:
git clone --recursive https://github.com/mhahnFr/LeakSanitizer.git && cd LeakSanitizer && make -j
```
Once you have a copy of this sanitizer you can install it using the following command:
The LeakSanitizer is automatically installed in the current directory.

To install it in a specific directory you can use the following command:
```shell
make INSTALL_PATH=/usr/local install
```
If you downloaded a release you can simply move the headers and the library anywhere
you like.
Adapt the value of the `INSTALL_PATH` argument to your needs.

> [!TIP]
> To create a portable build use the following command:
> ```shell
> make -j release
> ```
If you have downloaded a release or if you have created a portable build you can simply move the headers and the library
anywhere you like.
#### Uninstallation
Uninstall the sanitizer by simply removing its library and its header files from the installation directory.
This can be done using the following command:
```shell
make INSTALL_PATH=/usr/local uninstall
```
Adapt the value of the `INSTALL_PATH` argument to your needs.
### Updating
Update the LeakSanitizer by either downloading the new release or, when cloned from the repository, using:
Expand Down

0 comments on commit 448d5a2

Please sign in to comment.