From 7c24fb4e57296f35aa41d664449a3176e73a0e8d Mon Sep 17 00:00:00 2001 From: Kamil Zabielski <50334623+limakzi@users.noreply.github.com> Date: Mon, 23 Mar 2026 20:36:48 +0100 Subject: [PATCH 1/3] docs: Inform on versions available --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index cd17e8f..1e2c8d6 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,24 @@ T@{ shape: processes, label: "bare/slim/buildfull/full"} ``` +We have the following variants[^1]: + +* **`bare`** - Core compiled from source with only the `PackageManager` package installed. Required packages are loaded via `InstallRequiredPackages()` — no optional packages are compiled. This is the _smallest image_, suitable for minimal or custom setups where you want full control over which packages to add. + +* **`slim`** -- Includes additional runtime libraries needed by optional packages. Suitable for users who want to _selectively compile_ only the packages they need. + +* **`full`** - Contains _all packages compiled_ via `BuildPackages.sh --parallel`. It is the largest image and the most comprehensive variant. Recommended for most users. + +* **`jupyter-gap`** - A separate image based on the `full` variant. Adds `JupyterLab` and the `gap-kernel`. Exposes port `8888` and launches notebook as the default command. + +Besides that we have: + +* **`buildfull`** - An _internal build stage_ used to compile all packages for the `full` image. Referenced in the build pipeline but not intended for direct use. + +--- + +## Usage + * Run a container: ``` @@ -45,3 +63,5 @@ Although it was completely rewritten, this repository consists of various ideas [1]: https://github.com/james-d-mitchell/gap-docker-minimal [2]: https://github.com/stertooy/gda-image + +[^1]: All variants are based on `Ubuntu 22.04` LTS. From 8674fa321f7111d4ca0de9c2e43cfd644b82a9a6 Mon Sep 17 00:00:00 2001 From: Kamil Zabielski <50334623+limakzi@users.noreply.github.com> Date: Mon, 23 Mar 2026 20:44:07 +0100 Subject: [PATCH 2/3] docs: Update front-most gap-versions --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1e2c8d6..267406f 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ ```mermaid graph RL - V1[gap-docker:4.13.1-bare] --> T - V2[gap-docker:4.13.1-full] --> T - V3[gap-docker:4.13.1-slim] --> T - V4[gap-docker:4.13.1-buildfull] --> T + V1[gap-docker:4.15.1-bare] --> T + V2[gap-docker:4.15.1-full] --> T + V3[gap-docker:4.15.1-slim] --> T + V4[gap-docker:4.15.1-buildfull] --> T T --> V V --> G @@ -39,15 +39,15 @@ Besides that we have: * Run a container: ``` -docker run -it ghcr.io/gap-system/gap:4.13.1-full +docker run -it ghcr.io/gap-system/gap:4.15.1-full ``` ``` -docker run -it ghcr.io/gap-system/gap:4.14.0-full +docker run -it ghcr.io/gap-system/gap:4.15.0-full ``` ``` -docker run -it ghcr.io/gap-system/gap:4.13.1-bare +docker run -it ghcr.io/gap-system/gap:4.14.0-bare ``` ``` From da38939e7416888e165f46ed2960ab953a44c9f2 Mon Sep 17 00:00:00 2001 From: Kamil Zabielski <50334623+limakzi@users.noreply.github.com> Date: Mon, 23 Mar 2026 20:48:55 +0100 Subject: [PATCH 3/3] docs: Fix bullet punctuation Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 267406f..af9fdcc 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ We have the following variants[^1]: * **`bare`** - Core compiled from source with only the `PackageManager` package installed. Required packages are loaded via `InstallRequiredPackages()` — no optional packages are compiled. This is the _smallest image_, suitable for minimal or custom setups where you want full control over which packages to add. -* **`slim`** -- Includes additional runtime libraries needed by optional packages. Suitable for users who want to _selectively compile_ only the packages they need. +* **`slim`** - Includes additional runtime libraries needed by optional packages. Suitable for users who want to _selectively compile_ only the packages they need. * **`full`** - Contains _all packages compiled_ via `BuildPackages.sh --parallel`. It is the largest image and the most comprehensive variant. Recommended for most users.