Skip to content

Commit

Permalink
More detailed instructions on installation
Browse files Browse the repository at this point in the history
  • Loading branch information
penguin-teal committed Nov 5, 2023
1 parent af954dc commit 10eed7b
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,39 @@ of strings or data.
clhasher <options> <algorithm flag> <input>
```

## Installing/Uninstalling

To install:
- [Installing](#installing)
- [Uninstalling](#uninstalling)
- [Use](#use)
- [Algorithms](#algorithms)
- [Options](#options)
- [Escaping](#escaping)

## Installing
1. Clone the repository.
```shell
# Clone into directory 'clhasher'
git clone https://github.com/penguin-teal/clhasher.git clhasher
# Enter that directory
cd clhasher
# Go to specific release (v1.0.0 is latest)
git switch --detach v1.0.0
```
2. Install. To install there is a `make install` target and an optional `DESTDIR` variable.
```shell
# to /usr/local/bin:
make install
# Install to /usr/local/bin: (ROOT is required)
sudo make install
# or to other dir:
make install DESTDIR=/some/other/dir
# make install DESTDIR=/some/other/dir
```

## Uninstalling

To uninstall just `rm` the executable file:
```shell
# if you used make install:
# if you used make install: (ROOT is required)
rm /usr/local/bin/clhasher -i
# if you installed using DESTDIR=*:
rm /some/other/dir/clhasher -i
# or if you installed using DESTDIR=*:
# rm /some/other/dir/clhasher -i
```

## Use
Expand Down

0 comments on commit 10eed7b

Please sign in to comment.