Update Building the source code

Lucas Schwiderski 2023-11-28 12:02:16 +01:00
parent 7dcc3db06b
commit 68e291094e

@ -3,10 +3,23 @@
* [Rust](https://www.rust-lang.org/tools/install) * [Rust](https://www.rust-lang.org/tools/install)
* [Git](https://git-scm.com/) * [Git](https://git-scm.com/)
* [CMake](https://cmake.org/) * [CMake](https://cmake.org/)
* [Oodle](Obtaining-the-Oodle-library)
## Build ## Build manually
1. Clone the repository. Make sure to initialize submodules (e.g. `git clone --recurse-submodules`). 1. Clone the repository. Make sure to initialize submodules (e.g. `git clone --recurse-submodules`).
2. Acquire the library files as per [[Obtaining the Oodle library](./Obtaining-the-Oodle-library)] for your target operating system and place them into `lib/oodle`. 2. Place the Oodle library files into `lib/oodle`. See the linked page above for how to acquire them.
3. Run `cargo build --release`. 3. Run `cargo build --release`.
4. Find the executables in `target/release`. 4. Find the executables in `target/release`.
## Build with Docker
1. Clone the repository. Make sure to initialize submodules (e.g. `git clone --recurse-submodules`).
2. Place the Oodle library files into `lib/oodle`. See the linked page above for how to acquire them.
3. Build the images with
```sh
# The Linux image also serves as a base for the Windows image
docker build -t dtmt-ci-base-linux -f .ci/image/Dockerfile.linux .ci/image
# Ignore this one, if you build for Linux
docker build -t dtmt-ci-base-msvc -f .ci/image/Dockerfile.msvc .ci/image
```