napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: repair CONTRIBUTING, mention neon-unstable

Browse Source
This commit is contained in:
Adriaan de Groot 2023-10-03 14:05:37 +02:00
parent 125f54d830
commit 6b61197402
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -74,9 +74,10 @@ instructions are on the wiki.
### Simple Build in Docker ### Simple Build in Docker
You may have success with the Docker images that the CI system uses. You may have success with the Docker images that the CI system uses.
Pick one (or both): Pick one (or more) of these images which are also used in CI:
- `docker pull docker://opensuse/tumbleweed` - `docker pull docker://opensuse/tumbleweed`
- `docker pull kdeneon/plasma:user` - `docker pull kdeneon/plasma:user`
- `docker pull kdeneon/plasma:unstable`
Then start a container with the right image, from the root of Calamares Then start a container with the right image, from the root of Calamares
source checkout. Start with this command and substitute `opensuse/tumbleweed` source checkout. Start with this command and substitute `opensuse/tumbleweed`
@ -84,12 +85,12 @@ or `kdeneon/plasma:user` for the `$IMAGE` part.
``` ```
docker run -ti \ docker run -ti \
--tmpfs /build:rw --tmpfs /build:rw,exec \
--user 0:0 --user 0:0 \
-e DISPLAY=:0 -e DISPLAY=:0 \
-v /tmp/.X11-unix:/tmp/.X11-unix -v /tmp/.X11-unix:/tmp/.X11-unix \
-v .:/src -v .:/src \
$IMAGE $IMAGE \
bash bash
``` ```
@ -102,10 +103,16 @@ dependencies for the image (in this example, for openSUSE and Qt6).
- `cd /src` - `cd /src`
- `./ci/deps-opensuse-qt6.sh` - `./ci/deps-opensuse-qt6.sh`
Then run CMake (add any CMake options you like at the end) and ninja: Then run CMake (add any CMake options you like at the end) and ninja.
There is a script `ci/build.sh` that does this, too (without options).
- `cmake -S /src -B /build -G Ninja` - `cmake -S /src -B /build -G Ninja`
- `ninja -C /build` - `ninja -C /build`
To run Calamares inside the container, or e.g. `loadmodule` to test
individual modules, you may need to configure X authentication; a
simple and insecure way of doing that is to run `xhost +` in the host
environment of the Docker containers.
### Dependencies for Calamares 3.3 ### Dependencies for Calamares 3.3
> The dependencies for Calamares 3.3 reflect "resonably current" > The dependencies for Calamares 3.3 reflect "resonably current"