Browse Source

Building documentation improvements.

Removed redundant information about CMake and instead just linking to
what is already written somewhere else.
pull/34/head
Vladimír Vondruš 13 years ago
parent
commit
037c5adb8e
  1. 29
      doc/building.dox

29
doc/building.dox

@ -52,6 +52,10 @@ compressed archive or use the command line:
@section building-compilation Compilation, installation
Relevant information about CMake usage was described in
@ref building-corrade "Corrade download and installation guide", this guide is
assuming you have at least basic knowledge of CMake.
@subsection building-linux Via command-line (on Linux/Unix)
On Unix-based OSs, the library (for example with support for GLUT applications)
@ -64,12 +68,7 @@ can be built and installed using these four commands:
make
make install
The library provides a lot of CMake options (described in sections later). They
can be passed to CMake either as `-Dname=value` parameters on command-line
(like above) or set conveniently using `cmake-gui`:
cd build
cmake-gui .
See @ref building-features "below" for additional configuration options.
@subsection building-windows Using QtCreator and CMake GUI (on Windows)
@ -85,14 +84,11 @@ and you won't need to explicitly specify path to each one.
Then just open project's root `CMakeLists.txt` file within QtCreator. It then
asks you where to create build directory, allows you to specify initial CMake
parameters and then you can just press Configure and everything should be ready
to be built. You might need to set some CMake parameters before configuring,
they can be set with `-Dname=value`. See below for more information.
parameters and then you can just press *Configure* and everything is be ready
to be built.
After the initial import you might want to reconfigure some CMake variables
(more information below). Start CMake GUI, point it to the recently created
build dir, modify the variables and press Generate. QtCreator will detect the
changes and reparse the project accordingly.
After the initial import you might want to reconfigure some CMake variables,
see @ref building-features "below" for more information.
For most convenient usage it's best to set `CMAKE_INSTALL_PREFIX` to directory
where MinGW is installed (e.g. `C:/MinGW/`) and add `C:/MinGW/bin` and
@ -101,7 +97,7 @@ within QtCreator by adding new `make install` build rule.
@subsubsection building-windows-troubleshooting Windows troubleshooting
If CMake isn't able to find dependencies (e.g. Corrade is not found) and you
If CMake isn't able to find dependencies (e.g. %Corrade is not found) and you
have installed them to MinGW directory, point to `CMAKE_FIND_ROOT_PATH` to
MinGW installation prefix, e.g. specify `-DCMAKE_FIND_ROOT_PATH=C:/MinGW/`
CMake parameter.
@ -196,14 +192,15 @@ platform best:
@subsection building-tests Building and running unit tests
If you want to build also unit tests (which are not built by default), enable
`BUILD_TEST` in CMake. Unit tests use Corrade's @ref Corrade::TestSuite
`BUILD_TESTS` in CMake. Unit tests use Corrade's @ref Corrade::TestSuite
"TestSuite" framework and can be run either manually (the binaries are located
in `Test/` subdirectories of build directory) or using
ctest --output-on-failure
in build directory. On Windows the tests require the library to be installed
with DLLs accessible through `PATH`. See above for more information.
with DLLs accessible through `PATH`. See
@ref building-windows "above Windows documentation" for more information.
@subsection building-doc Building documentation

Loading…
Cancel
Save