Huffman Coding - Simple Text File Compressor

Simple compression/decompression tool fir text files using Huffman Coding.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Installation
2. Usage
3. Roadmap
4. Contributing
5. License
6. Contact

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/gct02/huffman-coding.git

(back to top)

Usage

huffman <command> <input_file> [<output_file>]

<command>: Specify the operation to perform: "zip" for compression or "unzip" for decompression.
<input_file>: Path to the file to be processed.
[<output_file>]: Path to the resulting file. Optional for "zip" operation; required for "unzip" operation.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Gabriel Tavares - gabrielc.tavares02@gmail.com

Project Link: https://github.com/gct02/huffman-coding

(back to top)