How to build RaZ

RaZ is built with the help of CMake. To generate the project, you must download and install CMake (scroll down to get the latest stable release). If you are on Linux, you had better install it from your package manager.

RaZ can be theoretically compiled with any C++17 compiler. There may be some inconsistencies between compilers or even versions, like missing includes; if so, please open an issue or submit a pull request.

At the time of writing, it is tested with (and is assumed to be compatible with any later version of) the following:

• Windows:
  • MinGW-w64 9.3.0 (prior versions from SourceForge are not compatible; those from WinLibs below 9.3.0 are untested)
  • MSVC 14.25
  • Clang-cl 9.0.0
  • Cygwin with Clang 8.0.1
• Linux:
  • GCC 8.4.0
  • Clang 7.0.1
• macOS:
  • Clang 11.0.3
• Emscripten:
  • EmSDK/emcc 1.39.13

Building on Windows

Writing in progress.

Installing RaZ on Windows can be made from the RaZ build directory by executing the command cmake --build . --target install.

By default, the install location is C:\RaZ. Feel free to move the installed files wherever you see fit, or directly into the directory you want by modifying the CMAKE_INSTALL_PREFIX variable (beware that depending on the location, you may be required to execute the installation as an administrator).

Building on Linux

Building RaZ requires a C++17-capable compiler (GCC 7+ or Clang 4/5+).

Writing in progress.

Installing RaZ on Linux can be made from the RaZ build directory by executing either the command make install or cmake --build . --target install.

By default, the install location is /usr/local, which is a standard place for user builds. This needs superuser rights (sudo make install or sudo cmake --build . --target install). If you don't have those, feel free to change the install location by modifying the CMAKE_INSTALL_PREFIX variable.

If for some reason you want to manually install RaZ without using the command above, you can execute the following ones from the RaZ root directory:

sudo cp -r include/RaZ /usr/local/include
sudo cp build/libRaZ.a /usr/local/lib

After doing this, you can include RaZ and link it with -lRaZ to use it in your project!