sdl2_frt/docs/README-cmake.md

CMake
================================================================================
(www.cmake.org)

SDL's build system was traditionally based on autotools. Over time, this
approach has suffered from several issues across the different supported 
platforms.
To solve these problems, a new build system based on CMake is under development.
It works in parallel to the legacy system, so users can experiment with it
without complication.
While still experimental, the build system should be usable on the following
platforms:
    
    * FreeBSD
    * Linux
    * VS.NET 2010
    * MinGW and Msys
    * OS X with support for XCode
    
================================================================================
Usage
================================================================================

Assuming the source for SDL is located at ~/sdl

cd ~
mkdir build
cd build
cmake ../sdl

This will build the static and dynamic versions of SDL in the ~/build directory.
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 2014-07-29 14:20:12 +02:00			`CMake`
Added a README file regarding WinRT support To note, this file is currently formatted with CRLF line endings, rather than LF, to allow the file to be viewed with Notepad. 2014-04-10 03:29:19 +02:00			`================================================================================`
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 2014-07-29 14:20:12 +02:00			`(www.cmake.org)`
Added a README file regarding WinRT support To note, this file is currently formatted with CRLF line endings, rather than LF, to allow the file to be viewed with Notepad. 2014-04-10 03:29:19 +02:00
			`SDL's build system was traditionally based on autotools. Over time, this`
			`approach has suffered from several issues across the different supported`
			`platforms.`
			`To solve these problems, a new build system based on CMake is under development.`
			`It works in parallel to the legacy system, so users can experiment with it`
			`without complication.`
			`While still experimental, the build system should be usable on the following`
			`platforms:`

			`* FreeBSD`
			`* Linux`
			`* VS.NET 2010`
			`* MinGW and Msys`
			`* OS X with support for XCode`

			`================================================================================`
			`Usage`
			`================================================================================`

			`Assuming the source for SDL is located at ~/sdl`

			`cd ~`
			`mkdir build`
			`cd build`
			`cmake ../sdl`

			`This will build the static and dynamic versions of SDL in the ~/build directory.`