X-Git-Url: https://code.octet-stream.net/hashgood/blobdiff_plain/a3d2b56ef2a311799ec802d1bc2075641eb5334d..69d73a1e6ca6798d880d79d0e5687c7a86019dd8:/README.md diff --git a/README.md b/README.md index 33cbdaf..a65754b 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,15 @@ # hashgood -A CLI tool for easily verifying a downloaded file's checksum. - -Wouldn't it be nice if your computer compared the hash for you? - -![](img/fail.png) -![](img/maybe.png) - -Read the MD5, SHA1 or SHA256 hash from: - -* Command line argument -* SHASUMS-style check files (`-c`) -* Raw hash in a file/STDIN (`-c`) -* The clipboard (`-p`) - -...or just run `hashgood` against the input and receive all three at once. - -This program arose from dissatisfaction with the [workarounds required for traditional tools](https://thomask.sdf.org/blog/2019/05/05/techniques-for-verifying-shasums-conveniently.html). - -## Installing - -If you have a working Rust toolchain you can install `hashgood` from crates.io: - -``` -cargo install hashgood --features paste -``` - -Pre-compiled binaries for common platforms can be downloaded [from the releases page](https://github.com/thombles/hashgood/releases). Otherwise you can build it yourself; see the next section. -## Compiling +A CLI tool for easily verifying a downloaded file's checksum. -`hashgood` targets stable Rust. With a Rust toolchain installed, clone the repository and run: +For user documentation, pre-built binaries, and more information about the project's goals, please visit the [website](https://octet-stream.net/p/hashgood/). -``` -cargo build --release -``` +## Build or Install from Source -Take the compiled executable from `target/release/hashgood`. +`hashgood` is a standard Rust binary project that can be built with `cargo build --release`. -To include support for pasting from the clipboard with `-p`, specify the extra feature. Note that on Linux this requires several extra libraries: `libxcb1-dev libxcb-xfixes0-dev libxcb-shape0-dev libxcb-render0-dev` +If you are a developer with a Rust toolchain it is possible to build and install `hashgood` directly from crates.io: ``` -cargo build --release --features paste +cargo install hashgood ``` - -## Goals - -* Be forgiving and deliver what the user wants with a minimum of fuss. They just want to check this hash, damnit. -* Don't let users be tricked - be explicit about checksum types and the sources of those checksums that are being compared. -* As much cross-platform support as is practical. - -## Non-goals - -* Scriptability. This is an interactive tool. -* Support for any unusual scenarios that could compromise smooth operation. (e.g., text mode, uncommon hash types) - -## Future ideas - -* Nominate a default (downloads) directory and auto-select the most recently created file in that directory as input.