README.md
1# RHash
2
3RHash (Recursive Hasher) is a console utility for calculation and
4verification of magnet links and various message digests, including CRC32, CRC32C,
5MD4, MD5, SHA1, SHA256, SHA512, SHA3, AICH, ED2K, DC++ TTH, BitTorrent BTIH,
6Tiger, GOST R 34.11-94, GOST R 34.11-2012, RIPEMD-160, HAS-160, EDON-R, and
7Whirlpool.
8
9Message digests are used to ensure and verify integrity of large volumes of
10data for a long-term storing or transferring.
11
12### Program features:
13 * Ability to process directories recursively.
14 * Output in a predefined (SFV, BSD-like) or a user-defined format.
15 * Calculation of Magnet links.
16 * Updating hash files (adding message digests of files missing in the hash file).
17 * Calculates several message digests in one pass.
18 * Portability: the program works the same on Linux, Unix, macOS or Windows.
19
20## Installation
21```shell
22./configure && make install
23```
24For more complicated cases of installation see the [INSTALL.md] file.
25
26## Documentation
27
28* RHash [ChangeLog]
29* [The LibRHash Library] documentation
30
31## Links
32* Project Home Page: http://rhash.sourceforge.net/
33* Official Releases: https://github.com/rhash/RHash/releases/
34* Binary Windows Releases: https://sf.net/projects/rhash/files/rhash/
35* The table of the supported by RHash [hash functions](http://sf.net/p/rhash/wiki/HashFunctions/)
36* ECRYPT [The Hash Function Zoo](http://ehash.iaik.tugraz.at/wiki/The_Hash_Function_Zoo)
37* ECRYPT [Benchmarking of hash functions](https://bench.cr.yp.to/results-hash.html)
38
39## Contribution
40Please read the [Contribution guidelines](docs/CONTRIBUTING.md) document.
41
42## License
43The code is distributed under [BSD Zero Clause License](COPYING).
44
45[INSTALL.md]: INSTALL.md
46[The LibRHash Library]: docs/LIBRHASH.md
47[ChangeLog]: ChangeLog
48