aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: be2587c387ce9bc5f4c45b589150e8bbb3013151 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
gzip-like LZSS compressor
===========================

A toy implementation of a simple gzip-like LZSS text compressor written in Nim.
This project is part of the compressor course at the Paris-East Marne-la-Vallée university.


Test and build
--------------

Building this project requires Nim and Nimble version 0.19.0 or later.

* `nimble build` produces a binary named `main`
* `nimble test` runs the included unit tests


Usage
-----

```
Usage: gziplike <compress|decompress> <input file> <output file>
```

Compression and decompression are done using the `compress` and `decompress` commands repsectively.

Paths to the input and output files are given as second and third arguments respectively.


License
-------

Copyright (C) 2018 Pacien TRAN-GIRARD.

This project is distributed under the terms of the GNU Affero General Public License v3.0, as detailed in the provided `license.md` file.