From 19de47d7ffc20264282a5ffeba110af059710fa7 Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Sun, 31 Oct 2021 17:34:04 +0000 Subject: [PATCH] Add README. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6fe4aaf --- /dev/null +++ b/README.md @@ -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 \ No newline at end of file