c4d9c1b9f8
There was and inconsistent usage of `#`, `##` and `###` in rustdoc headings. The difference in the rendered rustdocs is a minimal font size change. Change all headings to be H1 `#`. Change all subheadings to be `###` to have a noticeable difference in font size in the rendered docs. |
||
|---|---|---|
| .. | ||
| contrib | ||
| embedded | ||
| src | ||
| tests | ||
| CHANGELOG.md | ||
| Cargo.toml | ||
| README.md | ||
README.md
Bitcoin Hashes Library
This is a simple, no-dependency library which implements the hash functions needed by Bitcoin. These are SHA1, SHA256, SHA256d, SHA512, and RIPEMD160. As an ancillary thing, it exposes hexadecimal serialization and deserialization, since these are needed to display hashes anyway.
Minimum Supported Rust Version (MSRV)
This library should always compile with any combination of features on Rust 1.63.0.
Contributions
Contributions are welcome, including additional hash function implementations.
Githooks
To assist devs in catching errors before running CI we provide some githooks. If you do not already have locally configured githooks you can use the ones in this repository by running, in the root directory of the repository:
git config --local core.hooksPath githooks/
Alternatively add symlinks in your .git/hooks directory to any of the githooks we provide.
Running Benchmarks
We use a custom Rust compiler configuration conditional to guard the benchmark code. To run the
benchmarks use: RUSTFLAGS='--cfg=bench' cargo +nightly bench.