From 09205495388da657853ff1c9a82f2298b6f30edb Mon Sep 17 00:00:00 2001 From: stopiccot Date: Wed, 20 May 2015 22:09:22 +0300 Subject: Add CMake documentation to readme. Signed-off-by: Ralph Giles --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index bf15e34..1791506 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,39 @@ your system: (Build instructions for Ogg codecs such as vorbis are similar and may be found in those source modules' README files) +## Building with CMake ## + +Ogg supports building using [CMake](http://www.cmake.org/). CMake is a meta build system that generates native projects for each platform. +To generate projects just run cmake replacing `YOUR-PROJECT-GENERATOR` with a proper generator from a list [here](http://www.cmake.org/cmake/help/v3.2/manual/cmake-generators.7.html): + + cmake -G YOUR-PROJECT-GENERATOR . + +Note that by default cmake generates projects that will build static libraries. +To generate projects that will build dynamic library use `BUILD_SHARED_LIBS` option like this: + + cmake -G YOUR-PROJECT-GENERATOR -DBUILD_SHARED_LIBS=1 . + +After projects are generated use them as usual + +#### Building on Windows #### + +Use proper generator for your Visual Studio version like: + + cmake -G "Visual Studio 12 2013" . + +#### Building on Mac OS X #### + +Use Xcode generator. To build framework run: + + cmake -G Xcode -DBUILD_FRAMEWORK=1 . + +#### Building on Linux #### + +Use Makefile generator which is default one. + + cmake . + make + ## License ## THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. -- cgit v1.2.1