add README

This commit is contained in:
Jack Wines 2024-04-13 02:38:17 -07:00
parent 874d0b161d
commit ab7880216e
No known key found for this signature in database
GPG key ID: 25B20640600571E6

11
README.md Normal file
View file

@ -0,0 +1,11 @@
Compresses files using [Huffman coding](https://en.wikipedia.org/wiki/Huffman_coding). Please note that decompression isn't implemented yet.
To run with [Nix](nixos.org):
``` sh
nix run ".#" --experimental-features "nix-command flakes" -- myFile
```
To run with [cabal](https://www.haskell.org/ghcup/):
``` sh
cabal run . -- myFile
```