aaru-dps/Aaru.Compression.Native
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.Compression.Native.git synced 2025-12-16 19:24:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add README.

Browse Source
This commit is contained in:
Natalia Portillo
2021-10-31 17:34:04 +00:00
parent ea18f423f7
commit 19de47d7ff
1 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# Aaru.Compression.Native
This repository contains the Aaru.Compression.Native library for [Aaru](https://www.aaru.app).
The purpose of this library is to provide compression and de-compression algorithms for Aaru.
No archiver processing code should fall here, those go in [Aaru.Compression](https://github.com/aaru-dps/Aaru/tree/devel/Aaru.Compression).
To build you just need Docker on Linux and run `build.sh`, that will generate a NuGet package for use with Aaru.Compression.
Currently implemented algorithms are:
- Apple Data Compression (RLE with sliding dictionary created for Apple Disk Copy's NDIF)
- Apple RLE (Run Length Encoding created for Apple DART)
- [BZIP2](https://gitlab.com/bzip2/bzip2.git)
- [FLAC](https://github.com/xiph/flac)
- [LZFSE](https://github.com/lzfse/lzfse)
- [LZIP](http://www.nongnu.org/lzip)
- [LZMA](https://www.7-zip.org)
- [Zstandard](https://facebook.github.io/zstd)
Each of these algorithms have a corresponding license, that can be found in their corresponding folder.
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