ref: 98e7d70de745097165e1ea40ded2d3d7e16699b4
parent: 33bc39397f3bef48d5c1c688bfec929db653c9d5
author: Tuomas Virtanen <katajakasa@gmail.com>
date: Fri Apr 4 12:08:13 EDT 2014
Add readme file for cmake building. This adds a simple readme file for building the cmake project. It includes the most common flags and quick build/install commands.
--- /dev/null
+++ b/dumb/cmake/readme.txt
@@ -1,0 +1,30 @@
+Howto build libdumb with cmake
+==============================
+
+A quick example
+---------------
+
+In libdumb cmake directory (dumb/cmake/), run:
+```
+mkdir -p build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local -DBUILD_SHARED_LIBS:BOOL=ON ..
+make
+make install
+```
+
+Steps
+-----
+
+1. Create a new temporary build directory and cd into it
+2. Run libdumb cmake file with cmake (eg. `cmake -DCMAKE_INSTALL_PREFIX=/install/dir -DBUILD_SHARED_LIBS:BOOL=OFF -DCMAKE_BUILD_TYPE=Release path/to/dumb/cmake/dir`).
+3. Run make (eg. just `make` or `mingw32-make` or something).
+4. If needed, run make install.
+
+Flags
+-----
+
+* CMAKE_INSTALL_PREFIX sets the installation path prefix
+* CMAKE_BUILD_TYPE sets the build type (eg. Release, Debug, RelWithDebInfo, MinSizeRel). Debug libraries will be named libdumbd, release libraries libdumb.
+* BUILD_SHARED_LIBS selects whether cmake should build dynamic or static library (On=shared, OFF=static)
+* You may also need to tell cmake what kind of makefiles to create with the "-G" flag. Eg. for MSYS one would say something like `cmake -G "MSYS Makefiles" .`.