Skip to content

Commit

Permalink
docs: add install instrcutions
Browse files Browse the repository at this point in the history
  • Loading branch information
matmatias committed Dec 29, 2023
1 parent 76fcd55 commit aa57599
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,27 @@ String of 999 characters maximum.
- [make](https://www.gnu.org/software/make/)
- [cmake](https://cmake.org/)

## Install
You can get the todox binaries from the latest release.

- To install as a .deb package, run:
```bash
sudo dpkg -i todox_1.0_amd64.deb
```

Or you can just download the raw binary and put it in /usr/bin.

## Uninstalling
- To uninstall as a .deb package, run:
```bash
sudo apt uninstall todox
```

- To uninstall as a raw binary, run:
```bash
sudo rm /usr/bin/todox
```

## Setup
Create the build directory. From the root of the project, run:

Expand Down

0 comments on commit aa57599

Please sign in to comment.