aaru-dps/Aaru.Checksums.Native
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.Checksums.Native.git synced 2025-12-16 11:14:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add README.

Browse Source
This commit is contained in:
Natalia Portillo
2021-10-31 17:39:48 +00:00
parent b327568704
commit f575fd2d08
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md Normal file
View File

@@ -0,0 +1,26 @@
# Aaru.Checksums.Native
This repository contains the Aaru.Checksums.Native library for [Aaru](https://www.aaru.app).
The purpose of this library is to provide checksums and hashing algorithms for Aaru.
No archiver processing code should fall here, those go in [Aaru.Checksums](https://github.com/aaru-dps/Aaru.Checksums).
To build you just need Docker on Linux and run `build.sh`, that will generate a NuGet package for use with Aaru.Checksums.
Currently implemented algorithms are:
- Adler-32
- CRC-16 (CCITT and IBM polynomials)
- CRC-32 (ISO polynomial)
- CRC-64 (ECMA polynomial)
- Fletcher-16
- Fletcher-32
- SpamSum
Each of these algorithms have a corresponding license, that can be found in their corresponding file header.
The resulting output of `build.sh` falls under the LGPL 2.1 license as stated in the [LICENSE file](LICENSE).
Any new algorithm added should be under a license compatible with the LGPL 2.1 license to be accepted.
© 2021 Natalia Portillo