The project provides both a Dockerfile and Dev Container pre-configured for building the UKCP, to help contributors on different platforms run the build process easily, and to ensure reproducible builds.
Building can be done using a plain Docker container, or through Visual Studio Code's Dev Containers feature (recommended for most contributors).
Install Docker. Linux users may prefer to install Docker Engine only.
After setting up the project locally, build and launch the Docker container with the "dockerfile" file in the project root, either through Docker Desktop or via the Docker CLI:
docker run -it ./dockerfileThe process of building the container may take up to 20 minutes, depending on Internet connection speed.
Install VS Code, and Dev Containers.
After setting up the project locally, open it in VS Code. Press Ctrl Shift P to open the command palette. Search for "Dev Containers: Reopen in Container", and execute it by pressing Enter.
The process of building the container may take up to 20 minutes, depending on Internet connection speed.
To configure the build, first run:
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=$TOOLCHAIN -G Ninja -B buildThen, to execute the build, run:
ninja -C build UKControllerPluginCoreThe built DLL is written to "build/bin/UKControllerPluginCore.dll".
When making changes to the code, only the second command need be run to rebuild.
Ensure that all submodules are fully cloned before attempting any build processes.
Ensure that the line endings in all files are preserved; particularly, ensure that the line endings in the Dockerfile are LF, and are not converted to CRLF.
By default, Git is not installed within the container. Git operations should be performed on the host machine, or Git installed in the container.