Skip to content

Commit 2f82376

Browse files
limakziCopilot
andauthored
docs: Document versions in README.md (#130)
* docs: Inform on versions available * docs: Update front-most gap-versions * docs: Fix bullet punctuation Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs: Update README.md --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent a43c6b5 commit 2f82376

1 file changed

Lines changed: 27 additions & 7 deletions

File tree

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
```mermaid
88
graph RL
9-
V1[gap-docker:4.13.1-bare] --> T
10-
V2[gap-docker:4.13.1-full] --> T
11-
V3[gap-docker:4.13.1-slim] --> T
12-
V4[gap-docker:4.13.1-buildfull] --> T
9+
V1[gap-docker:4.15.1-bare] --> T
10+
V2[gap-docker:4.15.1-full] --> T
11+
V3[gap-docker:4.15.1-slim] --> T
12+
V4[gap-docker:4.15.1-buildfull] --> T
1313
T --> V
1414
V --> G
1515
@@ -18,18 +18,36 @@
1818
T@{ shape: processes, label: "bare/slim/buildfull/full"}
1919
```
2020

21+
We have the following variants[^1]:
22+
23+
* **`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.
24+
25+
* **`slim`** - Includes additional runtime libraries needed by optional packages. Suitable for users who want to _selectively compile_ only the packages they need. All deposited `GAP` packages (i.e. those distributed in the release archives) are included, but those requiring compilation _have not been_ compiled. Some system packages required to compile GAP packages are also installed in the container.
26+
27+
* **`full`** - Contains _all packages compiled_ via `BuildPackages.sh --parallel`. It is the largest image and the most comprehensive variant. Recommended for most users.
28+
29+
* **`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.
30+
31+
Besides that we have:
32+
33+
* **`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.
34+
35+
---
36+
37+
## Usage
38+
2139
* Run a container:
2240

2341
```
24-
docker run -it ghcr.io/gap-system/gap:4.13.1-full
42+
docker run -it ghcr.io/gap-system/gap:4.15.1-full
2543
```
2644

2745
```
28-
docker run -it ghcr.io/gap-system/gap:4.14.0-full
46+
docker run -it ghcr.io/gap-system/gap:4.15.0-full
2947
```
3048

3149
```
32-
docker run -it ghcr.io/gap-system/gap:4.13.1-bare
50+
docker run -it ghcr.io/gap-system/gap:4.14.0-bare
3351
```
3452

3553
```
@@ -45,3 +63,5 @@ Although it was completely rewritten, this repository consists of various ideas
4563

4664
[1]: https://github.com/james-d-mitchell/gap-docker-minimal
4765
[2]: https://github.com/stertooy/gda-image
66+
67+
[^1]: All variants are based on `Ubuntu 22.04` LTS.

0 commit comments

Comments
 (0)