aboutsummaryrefslogtreecommitdiffstats
path: root/doc/compiling/cmake-primer.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/compiling/cmake-primer.rst')
-rw-r--r--doc/compiling/cmake-primer.rst72
1 files changed, 0 insertions, 72 deletions
diff --git a/doc/compiling/cmake-primer.rst b/doc/compiling/cmake-primer.rst
deleted file mode 100644
index 499b8433..00000000
--- a/doc/compiling/cmake-primer.rst
+++ /dev/null
@@ -1,72 +0,0 @@
-
-.. _cmake-primer:
-
-************
-CMake primer
-************
-
-This chapter is a basic introduction to CMake, the build system used by PySide
-and the binding generator runner.
-
-The practical steps will focus on how to use cmake on a Unix-like (GNU/Linux)
-environment.
-
-
-Configuring
-===========
-
-Project file - CMakeLists.txt
------------------------------
-
-CMake parses the file CMakeLists.txt for information about the project,
-like project name, dependencies, what should be compiled, what should be
-shipped.
-
-
-CMake variables
----------------
-
-CMake can have its default behavior modified by providing some
-
-* ``CMAKE_INSTALL_PREFIX=<some path here>`` sets the install prefix to
- the specified path.
-* ``CMAKE_MODULE_PATH=<some path here>`` sets the extra directories
- where CMake will try to find its modules.
-* ``CMAKE_TOOLCHAIN_FILE=<file path>`` sets the path to the file that
- describes the toolchain used to compile this project. It is very useful
- when using CMake with icecc to speedup compilation.
-
-You can define a variable using the ``-D<VARIABLE>`` switch like the example
-below.
-
-* ``-DCMAKE_BUILD_TYPE=Release|Debug`` sets the building behavior. Default
- value is *Release*.
-
-Invoking CMake
---------------
-
-After writing the CMakeLists.txt and deciding which flags will be used,
-you can invoke CMake using::
-
- cmake <CMake flags> <path to toplevel CMakeLists.txt file>
-
-For example, if you use the ``build/`` folder to build the project and
-want it to be installed into ``/opt/sandbox/``, use the following lines::
-
- cd build/
- cmake -DCMAKE_INSTALL_PREFIX=/opt/sandbox ..
-
-CMake will process the project file and write the output files in the
-current directory
-
-Building
-========
-
-After the configuration process, the Makefiles are written and you can build
-the project using :program:`make`.
-
-Installing
-==========
-
-As in the building process, ``make install`` will install the files into
-the target directory.