Skip to content
Snippets Groups Projects
Verified Commit 6aa6cfc7 authored by Louis's avatar Louis :fire:
Browse files

Update readme with from-source installation instructions

parent 1f1ff9ef
No related branches found
No related tags found
No related merge requests found
......@@ -38,3 +38,26 @@ SUBCOMMANDS:
scale Make an image larger or smaller
```
## Downloads
Linux:
- [Latest Release](https://lab.lcr.gr/microhacks/crunch/-/jobs/artifacts/trunk/raw/target/release/crunch?job=build-linux)
## Build From Source
You can simply download this repository and run `cargo build --release` to get a binary for your system. Using `--release` mode
is required in all situations, as the time taken to run a command with the debug build is _several_ orders of magnitude higher.
If you use the `.local/bin` pattern for non-sudo userspace programs, you can use the included build script to simplify things. Otherwise,
follow the below instructions:
**Simple Script**
- Clone this repository
- Run `sh source-install.sh`
**Manual**
- Clone this repository
- Run `cargo build --release`
- Optionally, `strip` the binary
- Copy `target/release/crunch` to a folder located in your `$PATH`
\ No newline at end of file
#!/usr/bin/env sh
cargo build --release
strip release/target/crunch
chmod u+x release/target/crunch
cp release/target/crunch "$HOME/.local/bin/crunch"
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment