Skip to content

Commit

Permalink
Directions on updating
Browse files Browse the repository at this point in the history
  • Loading branch information
penguin-teal committed Nov 5, 2023
1 parent 10eed7b commit 6e82a33
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ clhasher <options> <algorithm flag> <input>
```

- [Installing](#installing)
- [Updating](#updating)
- [Uninstalling](#uninstalling)
- [Use](#use)
- [Algorithms](#algorithms)
- [Options](#options)
- [Escaping](#escaping)

## Installing

1. Clone the repository.
```shell
# Clone into directory 'clhasher'
Expand All @@ -25,14 +27,36 @@ 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.

2. Build the project.
```shell
# Make a release build
make release
```

3. Install. To install there is a `make install` target and an optional `DESTDIR` variable.
```shell
# Install to /usr/local/bin: (ROOT is required)
sudo make install
# or to other dir:
# make install DESTDIR=/some/other/dir
```

## Updating

```shell
# Go to where you cloned the repository
cd clhasher
# Get the changes
git pull
# Switch to latest (v1.0.0 is latest)
git switch --detach v1.0.0
# Clean just to be safe then build release again
make clean release
# Install like you did before (ROOT is required)
sudo make install
```

## Uninstalling

To uninstall just `rm` the executable file:
Expand Down

0 comments on commit 6e82a33

Please sign in to comment.