Commit 8c8c1b

2026-01-21 03:50:02 Matt Hughes: -/-
development/building pointcaster.md ..
@@ 1,24 1,28 @@
# Building Pointcaster
- Source code for Pointcaster is available [on Github](https://github.com/eidetic-av/pointcaster). Start by cloning the repository.
+ Source code for Pointcaster is available on [Github](https://github.com/eidetic-av/pointcaster). Start by cloning the repository:
+ ```sh
+ git clone https://github.com/eidetic-av/pointcaster.git
+ cd pointcaster
+ ```
## Linux
- 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, installation and configuration of all dependencies.
+ 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.
- The Pointcaster AppImage can be built using Docker or Podman from the repository root like so:
+ The Pointcaster AppImage can be built from the repository root like so:
```sh
- docker build -t pointcaster .
- docker run --rm -it -v ./:/pointcaster:Z -w/pointcaster pointcaster ./scripts/build-linux-release.sh
+ docker build -t pointcaster-linux .
+ docker run --rm -it -v ./:/pointcaster:Z -w /pointcaster pointcaster-linux ./scripts/build-linux-release.sh
```
-
The `docker run` command arguments ensure that the repository is mounted inside the container and set as the working directory.
For a development shell, invoke `bash` or `fish`, where you can configure and build using `cmake`:
- ```
+ ```sh
docker run --rm -it -v ./:/pointcaster:Z -w/pointcaster pointcaster bash
-
- # then inside the dev shell:
+ ```
+ Then from inside:
+ ```sh
cmake --preset linux-release
cmake --build build/linux-release
cmake --build build/linux-release --target install
@@ 27,7 31,6 @@
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.
> [!TIP]
- > The docker image is used as a base for a [devcontainer](https://containers.dev/) in IDEs that support it.
-
+ > 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).
## Windows
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9