|
|
# What is `compr`?
|
|
|
|
|
|
`compr` is a set a three executables and a `bash` script that allows one to study each stage of a gzip[^1]/DEFLATE[^2] compressor.
|
|
|
|
|
|
# Licensing information
|
|
|
|
|
|
`compr` is released as is, without any warranty, under a dual licensing scheme.
|
|
|
|
|
|
By default, `compr` is distributed under the [GNU Affero General Public License, version 3](https://www.gnu.org/licenses/agpl-3.0.html).
|
|
|
|
|
|
If you cannot comply with AGPLv3, please [contact us](mailto:cayre@uvolante.org?Subject=Alternative Software Licesing Inquiry for COMPR) for alternative licensing.
|
|
|
|
|
|
# Debian/Ubuntu repository
|
|
|
|
|
|
We provide pre-compiled binaries for Debian/Ubuntu `amd64` architectures.
|
|
|
|
|
|
See [these instructions](https://www.uvolante.org/apt) to add the repository to your system.
|
|
|
|
|
|
Once the repository is available on your system:
|
|
|
```
|
|
|
sudo apt install compr
|
|
|
```
|
|
|
|
|
|
# Source code
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
`compr` makes use of the following software:
|
|
|
|
|
|
* `clang`, `make`, `cmake`, `doxygen`, `git`, `crc32`
|
|
|
* the [`oops`](https://forge.uvolante.org/code/oops/wikis) library.
|
|
|
|
|
|
## Cloning the source repository
|
|
|
|
|
|
Once `oops` is compiled and installed, clone the `git` tree:
|
|
|
```
|
|
|
git clone https://forge.uvolante.org/code/compr.git
|
|
|
```
|
|
|
|
|
|
# References
|
|
|
|
|
|
[^1]: L. Peter Deutsch, _"GZIP file format specification version 4.3"_, [RFC1952](https://www.ietf.org/rfc/rfc1952.txt), May 1996.
|
|
|
[^2]: L. Peter Deutsch, _"DEFLATE Compressed Data Format Specification version 1.3"_, [RFC1951](https://www.ietf.org/rfc/rfc1951.txt), May 1996.
|
|
|
|