diff --git a/README.md b/README.md index 47a3285..fec94d5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # huffman-py -Huffman algorithm implementation in Python with a QT GUI. \ No newline at end of file +Huffman algorithm implementation in Python with a QT GUI. + +## Installation : +Graphviz must be installed on host system. (see https://graphviz.org/download/) +Don't forget to include dot executable in your PATH. (File is often there: /usr/local/bin/dot) + +huffman-py installation: ++ preferred method: +``` +cd +pip install . +``` ++ alternative method: +``` +cd +python setup.py build +python setup.py install +``` +Will create a huffman_py file to run the application. (Should be in ~/.local/bin) + + +## checks: +to run unit tests: +``` +cd +python -m unittest discover +``` \ No newline at end of file