From bcceb9501a31b0bd491b335aabd8a52b344bba26 Mon Sep 17 00:00:00 2001
From: "sam.hadow" <sam.hadow@inbox.lv>
Date: Thu, 25 May 2023 00:45:57 +0200
Subject: [PATCH] Update 'README.md'

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

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 <path to cloned git>
+pip install .
+```
++ alternative method:
+```
+cd <path to cloned git>
+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 <path to cloned git>
+python -m unittest discover
+```
\ No newline at end of file