X-Git-Url: http://git.mutantstargoat.com/user/nuclear/?a=blobdiff_plain;f=README.cmake;h=ffd387e682a03d41c3fcdfac4291d48168d51e68;hb=cd0898cee3e8d093c4edbafd87aa66661cdbce46;hp=51ab817e0d5fb6d3dcfbb2b3ffaa6588d6b2bc5b;hpb=4e946b7659667446ff0b30460a96c3b431750e76;p=freeglut

diff --git a/README.cmake b/README.cmake
index 51ab817..ffd387e 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,46 @@ Open the freeglut.sln file that was generated in your build directory,
 and compile as usual
 
 
+How to build freeglut on UNIX
+-----------------------------
+- 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
+- Make sure you have the basics for compiling code, such as C compiler
+  (e.g., GCC) and the make package.
+- Also make sure you have packages installed that provide the relevant
+  header files for x11 (including xrandr) and opengl (e.g.,
+  libgl1-mesa-dev, libx11-dev and libxrandr-dev on Debian/Ubuntu).
+- Install XInput: libxi-dev / libXi-devel
+- Run 'cmake .' in the freeglut directory to generate the makefile.
+- Run 'make' to build, and 'make install' to install freeglut.
+- If you wish to change any build options run 'ccmake .'
 
-Breakdown of CMake configuration options:
-TODO
+
+Breakdown of CMake configuration options
+----------------------------------------
+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_BUILD_SHARED_LIBS  [ON, OFF] Build freeglut as a shared library
+FREEGLUT_BUILD_STATIC_LIBS  [ON, OFF] Build freeglut as a static library
+FREEGLUT_GLES               [ON, OFF] Link with GLEs libraries instead
+                            of OpenGL
+FREEGLUT_PRINT_ERRORS       [ON, OFF] Controls whether errors are
+                            default handled or not when user does not
+                            provide an error callback
+FREEGLUT_PRINT_WARNINGS     [ON, OFF] Controls whether warnings are
+                            default handled or not when user does not
+                            provide an warning callback
+FREEGLUT_REPLACE_GLUT       [ON, OFF] For non-Windows platforms,
+                            freeglut is by default built as -lglut. if
+                            off, built as -lfreeglut. On Windows,
+                            libraries are always built as freeglut.
+INSTALL_PDB                 [ON, OFF] MSVC only: controls whether debug
+                            information files are included with the
+                            install or not