diff --git a/README.md b/README.md index d1a17be..0052560 100644 --- 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 -------