Added readme

2017-06-10 22:15:59 +09:00 · 2017-06-10 22:15:59 +09:00 · be8ac2f837
parent 09a7546509
commit be8ac2f837
1 changed files with 16 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,16 @@
+
+# Compiling
+
+Create a build directory.  
+`mkdir build`
+
+Generate makefile with CMake.  
+`cd build`
+`cmake -DCMAKE_INSTALL_PREFIX=./install -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=True ../src`
+
+Build the project.  
+`make`
+
+Optionally install the project to where CMAKE\_INSTALL\_PREFIX was set.
+`make install`
+