actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update cmake comments.

Browse Source
This commit is contained in:
Jason Felds
2015-07-12 07:31:38 -04:00
parent d7bd2d60f0
commit e7ba881168
1 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Build/README.md
+15 -18
View File
@@ -9,26 +9,27 @@ Install CMake
At first, you have to install CMake.
All OSes
===
The common way of installing CMake is to go to [CMake's download page](http://www.cmake.org/download/). At this time of writing, the latest versions are 3.3.0-rc3 and 3.2.3. Either version will work: the minimum version supported at this time is 2.8.12.
If this approach is used, consider using the binary distributions. Most should also provide a friendly GUI interface.
Windows
===
Describe Later.
For those that prefer package manager systems, [Chocolatey](https://chocolatey.org/) has a CMake package. Run `choco install cmake` to get the latest stable version.
Mac OS X
Mac OS X Specific
===
install by Homebrew:
$brew install cmake
install by MacPorts:
$port install cmake
For those that prefer package manager systems, both [Homebrew](http://brew.sh/) and [MacPorts](https://www.macports.org/) offer CMake as part of their offerings. Run `brew install cmake` or `port install cmake` respectively to get the latest stable version.
Linux
===
Describe Later.
There are many package managers available for Linux. Look at your manual for more details. Either that, or utilize the All OS specific approach.
CMake Installation
@@ -48,15 +49,11 @@ For the first setup, you will want to run this command:
`cmake -G {YourGeneratorHere} .. && cmake ..`
Replace {YourGeneratorHere} with one of the generator choices from `cmake --help`.
Replace {YourGeneratorHere} with one of the generator choices from `cmake --help`. As an example, Mac OS X users that want to have Xcode used would run `cmake -G Xcode .. && cmake ..` on their Terminal program.
If any cmake project file changes, you can just run `cmake .. && cmake ..` to get up to date.
If this by itself doesn't work, you may have to clean the cmake cache.
Use `rm -rf CMakeCache.txt CMakeScripts/ CMakeFiles/ cmake_install.txt` to do that, and then run the generator command again.
for example(Use Xcode):
$cmake -G Xcode .. && cmake ..
Use `rm -rf CMakeCache.txt CMakeScripts/ CMakeFiles/ cmake_install.txt` to do that, and then run the generator command again as specified above.
The reason for running cmake at least twice is to make sure that all of the variables get set up appropriately.
@@ -84,9 +81,9 @@ If you are generating makefiles with cmake, you will also need to specify your b
Most users will want to use `RELEASE` while some developers may want to use `DEBUG`.
When generating your cmake files for the first time (or after any cache delete),
pass in `-DCMAKE_BUILD_TYPE=Debug` for a debug build. We have `RelWithDbgInfo` and `MinSizeRel` available as well.
pass in `-DCMAKE_BUILD_TYPE=Debug` for a debug build. We have `RelWithDbgInfo` and `MinSizeRel` builds available as well.
It is advised to clean your cmake cache if you switch builds.
It is advised to clean your cmake cache if you switch build types.
Note that if you use an IDE like Visual Studio or Xcode, you do not need to worry about setting the build type.
You can edit the build type directly in the IDE.