Browse Source

Mention Clang in documentation to state it's officially supported.

pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
6ebac5f47d
  1. 6
      README.md
  2. 16
      doc/Building.dox

6
README.md

@ -20,9 +20,9 @@ crosscompiling.
Minimal dependencies Minimal dependencies
-------------------- --------------------
* C++ compiler with good C++11 support. Currently the only compiler which * C++ compiler with good C++11 support. Currently the only compilers which
supports everything needed is **GCC** >= 4.6. **Clang** >= 3.1 (from SVN) support everything needed are **GCC** >= 4.6 and **Clang** >= 3.1 (from
will probably work too. SVN).
* **CMake** >= 2.6 * **CMake** >= 2.6
* **OpenGL headers**, on Linux most probably shipped with Mesa * **OpenGL headers**, on Linux most probably shipped with Mesa
* **GLEW** - OpenGL extension wrangler * **GLEW** - OpenGL extension wrangler

16
doc/Building.dox

@ -9,9 +9,9 @@ already prepared packaging files, currently only
Minimal set of tools and libraries required for building is: Minimal set of tools and libraries required for building is:
- C++ compiler with good C++11 support. Currently the only compiler which - C++ compiler with good C++11 support. Currently the only compilers which
supports everything needed is **GCC** >= 4.6. **Clang** >= 3.1 (from SVN) support everything needed are **GCC** >= 4.6 and **Clang** >= 3.1 (from
will probably work too. SVN).
- **CMake** >= 2.6 - **CMake** >= 2.6
- **OpenGL** headers, on Linux most probably shipped with Mesa - **OpenGL** headers, on Linux most probably shipped with Mesa
- **GLEW** - OpenGL extension wrangler - **GLEW** - OpenGL extension wrangler
@ -26,6 +26,9 @@ The library can be built and installed using these four commands:
cmake -DCMAKE_INSTALL_PREFIX=/usr .. && make cmake -DCMAKE_INSTALL_PREFIX=/usr .. && make
make install make install
If you want to build with another compiler (e.g. Clang), pass
`-DCMAKE_CXX_COMPILER=clang++` to CMake.
@subsection BuildingTests Building and running unit tests @subsection BuildingTests Building and running unit tests
If you want to build also unit tests (which are not built by default), pass If you want to build also unit tests (which are not built by default), pass
`-DBUILD_TESTS=True` to CMake. Unit tests use QtTest framework (you need at `-DBUILD_TESTS=True` to CMake. Unit tests use QtTest framework (you need at
@ -56,6 +59,13 @@ without downloading anything. The PKGBUILD also contains `check()` function
which will run all unit tests before packaging. Note that the unit tests which will run all unit tests before packaging. Note that the unit tests
require Qt, as said above. require Qt, as said above.
If you want to build with another compiler (e.g. Clang), run makepkg this way:
CXX=clang++ makepkg
Both development PKGBUILDs can detect when Clang is used and remove
unsupported CXX flags.
@section BuildingWin Crosscompiling for Windows using MinGW @section BuildingWin Crosscompiling for Windows using MinGW
@note This guide is tailored mainly for crosscompiling from ArchLinux. For @note This guide is tailored mainly for crosscompiling from ArchLinux. For
this system there is also prepared `mingw32-magnum` development package in this system there is also prepared `mingw32-magnum` development package in

Loading…
Cancel
Save