added CMake usage instructions
authorSergiu Dotenco <sergiu.dotenco@th-nuernberg.de>
Fri, 8 Jan 2016 14:21:24 +0000 (15:21 +0100)
committerSergiu Dotenco <sergiu.dotenco@th-nuernberg.de>
Fri, 8 Jan 2016 14:31:10 +0000 (15:31 +0100)
cmake/INSTALL.md [new file with mode: 0644]

diff --git a/cmake/INSTALL.md b/cmake/INSTALL.md
new file mode 100644 (file)
index 0000000..bdc1cd9
--- /dev/null
@@ -0,0 +1,30 @@
+Building Glog with CMake
+========================
+
+1. Create a build directory and `cd` to it.
+2. Run
+    ```bash
+    cmake path/to/glog
+    ```
+
+3. Afterwards, generated files (GNU make, Visual Studio, etc.) can be used to
+   compile the project.
+
+
+Consuming Glog in a CMake Project
+=================================
+
+To use Glog in your project `myproj`, use:
+
+```cmake
+cmake_minimum_required (VERSION 3.0)
+project (myproj)
+
+find_package (glog 0.3.4 REQUIRED)
+
+add_executable (myapp main.cpp)
+target_link_libraries (myapp glog::glog)
+```
+
+Compile definitions and options will be added automatically to your target as
+needed.