Format tweaks, added some examples.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9919 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

1 files changed, 47 insertions, 31 deletions

diff --git a/README.CMake.txt b/README.CMake.txt
index 780ad755b..b8b9b85fc 100644
--- a/README.CMake.txt
+++ b/README.CMake.txt
@@ -69,29 +69,35 @@ toolchain.  Other platforms are just as easy to use.
 
  OPTIONS
 ---------
+Options can be specified to cmake with the -D flag:
+
+    cmake -D <OPTION_NAME>=<OPTION_VALUE>
+
+Example:
+
+    cmake -D CMAKE_BUILD_TYPE=Debug
 
 All options have sensible defaults so you won't usually need to touch these.
-There are only two CMake options that you may want to specify.
+There are only two CMake options that you may want to specify:
 
 CMAKE_BUILD_TYPE
-   This specifies what kind of build this is i.e. Release, Debug...
-Platform specific compile/link flags/options are automatically selected
-by CMake depending on this value.
+    This specifies what kind of build this is i.e. Release, Debug...
+    Platform specific compile/link flags/options are automatically selected
+    by CMake depending on this value.
 
 CMAKE_INSTALL_PREFIX
-   Where everything will go on install.  Defaults are /usr/local for unix
-and C:\Program Files\FLTK for Windows.
+    Where everything will go on install.  Defaults are /usr/local for unix
+    and C:\Program Files\FLTK for Windows.
 
-These are the FLTK specific options.  Platform specific options are ignored
-on other platforms.
+The following are the FLTK specific options.  Platform specific options
+are ignored on other platforms.
 
 OPTION_OPTIM
    Extra optimization flags.
+
 OPTION_ARCHFLAGS
    Extra architecture flags.
 
-   The OPTION_PREFIX_* flags are for fine-tuning where everything goes
-on the install.
 OPTION_PREFIX_BIN
 OPTION_PREFIX_LIB
 OPTION_PREFIX_INCLUDE
@@ -99,20 +105,25 @@ OPTION_PREFIX_DATA
 OPTION_PREFIX_DOC
 OPTION_PREFIX_CONFIG
 OPTION_PREFIX_MAN
+   The OPTION_PREFIX_* flags are for fine-tuning where everything goes
+   on the install.
 
 OPTION_APPLE_X11 - default OFF
    In case you want to use X11 on OSX.  Not currently supported.
+
 OPTION_USE_POLL - default OFF
    Don't use this one either.
 
 OPTION_BUILD_SHARED_LIBS - default OFF
    Normally FLTK is built as static libraries which makes more portable
-binaries.  If you want to use shared libraries, this will build them too.
+   binaries.  If you want to use shared libraries, this will build them too.
+
 OPTION_BUILD_EXAMPLES - default ON
    Builds the many fine example programs.
 
 OPTION_CAIRO - default OFF
    Enables libcairo support
+
 OPTION_CAIROEXT - default OFF
    Enables extended libcairo support
 
@@ -125,17 +136,16 @@ OPTION_USE_THREADS - default ON
 OPTION_LARGE_FILE - default ON
    Enables large file (>2G) support
 
-   FLTK has built in jpeg zlib and png libraries.  These let you use
-system libraries instead, unless CMake can't find them.
 OPTION_USE_SYSTEM_LIBJPEG - default ON
 OPTION_USE_SYSTEM_ZLIB - default ON
 OPTION_USE_SYSTEM_LIBPNG - default ON
+   FLTK has built in jpeg zlib and png libraries.  These let you use
+   system libraries instead, unless CMake can't find them.
 
-   X11 extended libraries.
 OPTION_USE_XINERAMA - default ON
 OPTION_USE_XFT - default ON
 OPTION_USE_XDBE - default ON
-
+   These are X11 extended libraries.
 
  BUILDING UNDER LINUX WITH UNIX MAKEFILES
 ------------------------------------------
@@ -143,24 +153,30 @@ OPTION_USE_XDBE - default ON
 After untaring the FLTK source, go to the root of the FLTK tree and type
 the following.
 
-mkdir build
-cd build
-cmake ..
-make
-sudo make install
+    mkdir build
+    cd build
+    cmake ..
+    make
+    sudo make install
 
 This will build and install a default configuration FLTK.
 
+Some flags can be changed during the 'make' command, such as:
+
+    make VERBOSE=on
+
+..which builds in verbose mode, so you can see all the compile/link commands.
+
 
  CROSSCOMPILING
 ----------------
 
-Once you have a crosscompiler going, to use CMAke to build FLTK you need
+Once you have a crosscompiler going, to use CMake to build FLTK you need
 two more things.  You need a toolchain file which tells CMake where your
 build tools are.  The CMake website is a good source of information on
 this file.  Here's mine for MinGW under Linux.
-----
 
+----
 # the name of the target operating system
 set(CMAKE_SYSTEM_NAME Windows)
 
@@ -180,7 +196,6 @@ set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
 
 set(CMAKE_INSTALL_PREFIX ${CMAKE_FIND_ROOT_PATH}/usr CACHE FILEPATH
    "install path prefix")
-
 ----
 
 Not too tough.  The other thing you need is a native installation of FLTK
@@ -189,11 +204,11 @@ compile the *.fl into C++ source and header files.
 
 So, again from the FLTK tree root.
 
-mkdir mingw
-cd mingw
-cmake -DCMAKE_TOOLCHAIN_FILE=~/projects/toolchain/Toolchain-mingw32.cmake ..
-make
-sudo make install
+    mkdir mingw
+    cd mingw
+    cmake -DCMAKE_TOOLCHAIN_FILE=~/projects/toolchain/Toolchain-mingw32.cmake ..
+    make
+    sudo make install
 
 This will create a default configuration FLTK suitable for mingw/msys and
 install it in the /usr/i486-mingw32/usr tree.
@@ -246,15 +261,15 @@ a gui app.  It is ignored on other platforms.
 When you use the target_link_libraries command, CMake uses it's own
 internal names for libraries.  The fltk library names are:
 
-fltk     fltk_forms     fltk_images    fltk_gl
+    fltk     fltk_forms     fltk_images    fltk_gl
 
 and for the shared libraries (if built):
 
-fltk_SHARED     fltk_forms_SHARED     fltk_images_SHARED    fltk_gl_SHARED
+    fltk_SHARED     fltk_forms_SHARED     fltk_images_SHARED    fltk_gl_SHARED
 
 The built-in libraries (if built):
 
-fltk_jpeg      fltk_png    fltk_z
+    fltk_jpeg      fltk_png    fltk_z
 
 
  USING FLUID FILES
@@ -285,3 +300,4 @@ when find_package(FLTK REQUIRED NO_MODULE) succeeds.
 ==================
 
 Dec 20 2010 - matt: merged and restructures
+May 15 2013 - erco: small formatting tweaks, added some examples