From: John Tsiombikas <nuclear@member.fsf.org>
Date: Tue, 13 Mar 2012 19:05:32 +0000 (+0000)
Subject: Added a few more details to README.cmake
X-Git-Url: http://git.mutantstargoat.com/user/nuclear/?a=commitdiff_plain;h=d5fe9defa4070c483c1d04e0af8faf7150ead4ed;p=freeglut

Added a few more details to README.cmake



git-svn-id: svn+ssh://svn.code.sf.net/p/freeglut/code/trunk/freeglut/freeglut@1126 7f0cb862-5218-0410-a997-914c9d46530a
---

diff --git a/README.cmake b/README.cmake
index 51ab817..f776087 100644
--- a/README.cmake
+++ b/README.cmake
@@ -1,4 +1,5 @@
-How to build freeglut with CMake:
+How to build freeglut with CMake on Windows (MS Visual Studio)
+--------------------------------------------------------------
 1.  Download CMake (http://www.cmake.org/cmake/resources/software.html).
     Get one of the releases from the binary distribution section.
 2.  Run the CMake installer, install wherever you like. 
@@ -28,6 +29,26 @@ Open the freeglut.sln file that was generated in your build directory,
 and compile as usual
 
 
+How to build freeglut on UNIX
+-----------------------------
+1.  Make sure you have cmake installed. Examples:
+    - Debian/Ubuntu: apt-get install cmake
+    - Fedora: yum install cmake
+    - FreeBSD: cd /usr/ports/devel/cmake && make install
+    Or directly from their website:
+    http://www.cmake.org/cmake/resources/software.html
+2.  Run cmake . in the freeglut directory to generate the makefile.
+3.  Run make to build, and make install to install, freeglut.
+4.  If you wish to change any build options run ccmake .
 
-Breakdown of CMake configuration options:
-TODO
+
+Breakdown of CMake configuration options
+----------------------------------------
+BUILD_SHARED_LIBS       [ON, OFF] Build freeglut as a shared library
+BUILD_STATIC_LIBS       [ON, OFF] Build freeglut as a static library
+CMAKE_BUILD_TYPE        [Empty, Debug, Release] Can be overriden by passing it
+                        as a make variable during build.
+CMAKE_INSTALL_PREFIX	Installation prefix (e.g. /usr/local on UNIX)
+FREEGLUT_BUILD_DEMOS	[ON, OFF] Controls whether the demos are built or not.
+FREEGLUT_GLES1          [ON, OFF] TODO
+FREEGLUT_GLES2          [ON, OFF] TODO