Merge branch 'master' of https://github.com/fgarcia0x0/huffPP

fgarcia0x0 · May 5, 2021 · d7423be · d7423be
2 parents 5893b71 + 5765075
commit d7423be
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,18 @@
 # huffPP
 The huffPP (Huffman Coding Plus Plus) is a utility tool written in C++ 20 to compact and unzip files using the huffman coding algorithm.
+
+## System Requirements
+- compiler that support at least C++ 20
+- cmake
+- ninja
+
+## How to Compile
+**Enter in your terminal:**
+
+```sh
+cmake -S . -B build -GNinja -DCMAKE_BUILD_TYPE=Debug|Release
+```
+**Go to the build folder, then:**
+```sh
+cmake --build . -- -j 4
+```