doc/README-cmake.md
author Gabriel Jacobo <gabomdq@gmail.com>
Tue, 29 Jul 2014 09:20:12 -0300
changeset 9023 276802355854
permissions -rw-r--r--
Rearrange documentation

1) Moves all READMEs to docs/
2) Renames them to *.md, adds some Markdown with the idea to add a lot more
3) Moves the doxyfile config to doc/ and makes it parse the headers at ../include as well as the md files in docs.
4) Skips SDL_opengl*.h headers from the docs
5) Minor fixes to doxyfile
gabomdq@9023
     1
CMake
gabomdq@9023
     2
================================================================================
gabomdq@9023
     3
(www.cmake.org)
gabomdq@9023
     4
gabomdq@9023
     5
SDL's build system was traditionally based on autotools. Over time, this
gabomdq@9023
     6
approach has suffered from several issues across the different supported 
gabomdq@9023
     7
platforms.
gabomdq@9023
     8
To solve these problems, a new build system based on CMake is under development.
gabomdq@9023
     9
It works in parallel to the legacy system, so users can experiment with it
gabomdq@9023
    10
without complication.
gabomdq@9023
    11
While still experimental, the build system should be usable on the following
gabomdq@9023
    12
platforms:
gabomdq@9023
    13
    
gabomdq@9023
    14
    * FreeBSD
gabomdq@9023
    15
    * Linux
gabomdq@9023
    16
    * VS.NET 2010
gabomdq@9023
    17
    * MinGW and Msys
gabomdq@9023
    18
    * OS X with support for XCode
gabomdq@9023
    19
    
gabomdq@9023
    20
================================================================================
gabomdq@9023
    21
Usage
gabomdq@9023
    22
================================================================================
gabomdq@9023
    23
gabomdq@9023
    24
Assuming the source for SDL is located at ~/sdl
gabomdq@9023
    25
gabomdq@9023
    26
cd ~
gabomdq@9023
    27
mkdir build
gabomdq@9023
    28
cd build
gabomdq@9023
    29
cmake ../sdl
gabomdq@9023
    30
gabomdq@9023
    31
This will build the static and dynamic versions of SDL in the ~/build directory.