Blame

432b0b Matt Hughes 2026-01-16 04:54:20
add build page
1
# Building Pointcaster
2
8c8c1b Matt Hughes 2026-01-21 03:50:02
3
Source code for Pointcaster is available on [Github](https://github.com/eidetic-av/pointcaster). Start by cloning the repository:
4
```sh
5
git clone https://github.com/eidetic-av/pointcaster.git
6
cd pointcaster
7
```
63a237 Matt Hughes 2026-01-16 05:25:14
8
432b0b Matt Hughes 2026-01-16 04:54:20
add build page
9
## Linux
10
8c8c1b Matt Hughes 2026-01-21 03:50:02
11
Builds on Linux use a containerised environment created using the [Dockerfile](https://github.com/eidetic-av/pointcaster/blob/qt/Dockerfile) in the root of the repository. This handles download and configuration of all dependencies. Either [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) must be installed and configured on your system to proceed.
e6e300 Matt Hughes 2026-01-16 05:14:27
12
8c8c1b Matt Hughes 2026-01-21 03:50:02
13
The Pointcaster AppImage can be built from the repository root like so:
e6e300 Matt Hughes 2026-01-16 05:14:27
14
```sh
8c8c1b Matt Hughes 2026-01-21 03:50:02
15
docker build -t pointcaster-linux .
16
docker run --rm -it -v ./:/pointcaster:Z -w /pointcaster pointcaster-linux ./scripts/build-linux-release.sh
e6e300 Matt Hughes 2026-01-16 05:14:27
17
```
18
The `docker run` command arguments ensure that the repository is mounted inside the container and set as the working directory.
19
20
For a development shell, invoke `bash` or `fish`, where you can configure and build using `cmake`:
8c8c1b Matt Hughes 2026-01-21 03:50:02
21
```sh
e6e300 Matt Hughes 2026-01-16 05:14:27
22
docker run --rm -it -v ./:/pointcaster:Z -w/pointcaster pointcaster bash
8c8c1b Matt Hughes 2026-01-21 03:50:02
23
```
24
Then from inside:
25
```sh
77dd37 Matt Hughes 2026-01-21 03:38:38
26
cmake --preset linux-release
27
cmake --build build/linux-release
28
cmake --build build/linux-release --target install
29
cmake --build build/linux-release --target package
e6e300 Matt Hughes 2026-01-16 05:14:27
30
```
31
4ab926 Matt Hughes 2026-01-16 05:30:31
32
The install target places a portable build at `build/linux-release/install/bin/pointcaster`, and the package target creates an AppImage at `build/linux-release/Pointcaster-Linux-<version>.AppImage`, both of which can be run from outside the container.
0e386a Matt Hughes 2026-01-21 03:40:30
33
> [!TIP]
8c8c1b Matt Hughes 2026-01-21 03:50:02
34
> The docker image is used as a base for a [Development Container](https://containers.dev/) in IDEs that support it. Visual Studio Code will automatically install extensions needed for C++, CMake and QML. See the [devcontainer.json](https://github.com/eidetic-av/pointcaster/blob/qt/.devcontainer/devcontainer.json).
77dd37 Matt Hughes 2026-01-21 03:38:38
35
432b0b Matt Hughes 2026-01-16 04:54:20
add build page
36
## Windows
891c5a Matt Hughes 2026-03-14 14:08:46
37
- Enable Hyper-V & Containers Windows Features
38
- Install docker desktop
39
- Switching docker engine:
40
```pwsh
41
& "$Env:ProgramFiles\Docker\Docker\DockerCli.exe" -SwitchDaemon
42
```
43
- Win11 version < 24H2 maybe?:
44
```pwsh
45
docker pull mcr.microsoft.com/windows/server:ltsc2022
46
```
47
- Only newer win versions can use ltsc2025 maybe?