huffcomp 0.1.21

Huffman coding program for compression and decompression of text files
Documentation 
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# huffcomp


Huffman coding program for compression and decompression of text files.

## Installation


If you're a **Rust programmer**, huffcomp can be installed with `cargo`.

```
$ cargo install huffcomp
```

## Building


huffcomp can be build from source code using the Rust compiler.

```
$ git clone https://github.com/AlexRiosJ/huffcomp.git
$ cd huffcomp
$ cargo build --release
```

## Usage


It is possible for huffcomp to compress any kind of files that have UTF-8 valid encoding. (e.g. *.txt, *.c, *.rs, *.java, *.js)

To compress the file:

```
$ huffcomp -c <filename>
```

This command will generate a HUFF file (*.huff) which will have the same name as the original but with the huffcomp extension concatenated at the end.

To decompress a file it must have this extension and be compressed by huffcomp previously.

To decompress the file:

```
$ huffcomp -d <huffcomp_file>
```

### Contribute


To contribute, please fork the [repository](https://github.com/AlexRiosJ/huffcomp). If you find any bugs, issues or suggestions, please post your Issues and create your Pull Requests.

#### Used Techniques


- Huffman Coding Tree implementation.
- Bit level operations.
- Write and read files.