Added build instructions.

2017-07-02 12:10:26 +02:00
parent da483c5ba4
commit 605a91bc41
1 changed files with 11 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -17,6 +17,17 @@ _There are currently no clients available._

 Building
 --------
+This project has a few dependencies necessary for proper functionality. Please install the following:
+ - CMake
+
+To compile run the following commands:
+```
+$ cd build/
+$ cmake ..
+$ make
+```
+
+By default this will build a `release` build, if you require a debug build run the `cmake` command with the additional parameter `-DCMAKE_BUILD_TYPE=debug`.

 License
 -------