Updated formatting of documentation plus a little reorganization.
[cmake.git] / Readme.txt
blobe91fc713a370e68d1a215b1e5fe0d807e7508533
1 This is CMake, the cross-platform, open-source make system.
2 CMake is free software under a BSD-like license, see Copyright.txt.
3 For documentation see the Docs/ directory once you have built CMake
4 or visit http://www.cmake.org.
7 Building CMake
8 ==============
11 Supported Platforms
12 -------------------
14 MS Windows, Mac OS X, Linux, FreeBSD, Solaris, HP-UX, IRIX, BeOS, QNX
16 Other UNIX-like operating systems may work too out of the box, if not
17 it shouldn't be a major problem to port CMake to this platform. Contact the
18 CMake mailing list in this case: http://www.cmake.org/mailman/listinfo/cmake
21 If you don't have any previous version of CMake already installed
22 --------------------------------------------------------------
24 * UNIX/Mac OSX/MinGW/MSYS/Cygwin:
26 You need to have a compiler and a make installed.
27 Run the bootstrap script you find the in the source directory of CMake.
28 You can use the --help option to see the supported options.
29 You may want to use the --prefix=<install_prefix> option to specify a custom
30 installation directory for CMake. You can run the bootstrap script from
31 within the CMake source directory or any other build directory of your
32 choice. Once this has finished successfully, run make and make install.
33 So basically it's the same as you may be used to from autotools-based
34 projects:
36 $ ./bootstrap; make; make install
39 * Other Windows:
41 You need to download and install a binary release of CMake in order to build
42 CMake.  You can get these releases from
43 http://www.cmake.org/HTML/Download.html .  Then proceed with the instructions
44 below.
47 You already have a version of CMake installed
48 ---------------------------------------------
50 You can build CMake as any other project with a CMake-based build system:
51 run the installed CMake on the sources of this CMake with your preferred
52 options and generators. Then build it and install it.
53 For instructions how to do this, see http://www.cmake.org/HTML/RunningCMake.html