Building T'Pau C++ Kernal
This tutorial shows how to build T'Pau C++ Kernal from source. It assumes basic familiarity with using the command line and building software from source.
It uses cmake to invoke all required commands to be platform-independent. You can, of course, also use the underlying commands directly.
Dependencies
T'Pau C++ Kernal requires a C++20 compiler. It has been tested with gcc, clang, and MSVC. It also requires CMake (version 3.10 or later) and any of the supported build tools like Ninja, Make, or Visual Studio.
For running the tests, you need to have Catch2, Python, and nihtest installed.
How to install the dependencies depends on your operating system. On Linux, you can usually install them via your package manager. On macOS, you can use Homebrew or Mac Ports. On Windows, you can use vcpkg. Details on how to use these package managers is beyond the scope of this guide, but should be easy to find online.
Building T'Pau C++ Kernal
1. Clone the repository and navigate to the top level directory.
Since there are no official releases yet, you will have to clone the repository.
2. Create a build directory and navigate to it.
3. Run cmake to configure the build system.
If you want to customize the build, you can pass additional parameters to cmake after.. in the form of -Dparameter=value. See below for some useful parameters:
CMAKE_INSTALL_PREFIX- for setting the installation path
If you want to compile with custom CFLAGS, set them in the environment before running cmake:
You can also check the cmake FAQ for more information.
4. Build T'Pau C++ Kernal.
5. Run the test suite (optional).
To check that T'Pau C++ Kernal works as expected, run the test suite.
The number after -j specifies how many tests to run in parallel. 20 is a good default for modern systems.
6. Install T'Pau C++ Kernal (optional).
You can use the library in other projects directly from the build directory. However, it is more convenient to install it to a system-wide location.
Installing to the default location may require root privileges. You can specify a different installation location by passing -DCMAKE_INSTALL_PREFIX=/path/to/install to cmake in step 3.