Skip to content

Commit 8c65ba6

Browse files
committed
docs: Improve display of available images
1 parent 77bcb9c commit 8c65ba6

File tree

2 files changed

+36
-28
lines changed

2 files changed

+36
-28
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
## Images
44

5-
- slicer/slicer-notebook
6-
[![slicer-notebook-images](https://img.shields.io/docker/image-size/slicer/slicer-notebook/latest)](https://hub.docker.com/r/slicer/slicer-notebook)
7-
Ready-to-run Docker images containing Slicer and Jupyter. See [usage](#usage-of-slicer-notebook-image) information below.
8-
9-
- slicer/slicer-base
10-
[![slicer-base-images](https://img.shields.io/docker/image-size/slicer/slicer-base/latest)](https://hub.docker.com/r/slicer/slicer-base)
11-
The image used to build Slicer each time a Pull Request is submitted.
12-
For more details, see [GitHub Actions workflow](https://github.com/Slicer/Slicer/tree/main/.github)
5+
### slicer/slicer-notebook
6+
7+
[![slicer-notebook-images](https://img.shields.io/docker/image-size/slicer/slicer-notebook/latest)](https://hub.docker.com/r/slicer/slicer-notebook)
8+
Ready-to-run Docker images containing Slicer and Jupyter. See [usage](#usage-of-slicer-notebook-image) information below.
9+
10+
### slicer/slicer-base
11+
12+
[![slicer-base-images](https://img.shields.io/docker/image-size/slicer/slicer-base/latest)](https://hub.docker.com/r/slicer/slicer-base)
13+
The image used to build Slicer each time a Pull Request is submitted.
14+
For more details, see [GitHub Actions workflow](https://github.com/Slicer/Slicer/tree/main/.github)
1315

1416
### Unmaintained Images
1517

unmaintained-images.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,36 @@
1-
# Unmaintained Images
1+
# Docker images for 3D Slicer
2+
3+
## Unmaintained Images
24

35
In the process of improving the Slicer infrastructure, these images are
46
not updated anymore. Only the `slicer/slicer-base` image is used for
5-
continuous integration with [GitHub Actionsworkflow](https://github.com/Slicer/Slicer/tree/main/.github).
7+
continuous integration with [GitHub Actions workflow](https://github.com/Slicer/Slicer/tree/main/.github).
8+
9+
### slicer/slicer-dependencies
10+
11+
[![slicer-dependencies-images](https://img.shields.io/docker/image-size/slicer/slicer-dependencies/latest)](https://hub.docker.com/r/slicer/slicer-dependencies)
12+
An image containing all the dependencies to build Slicer itself:
13+
ITK, VTK, CTK, Qt, etc.
14+
15+
### slicer/slicer-build
16+
17+
[![slicer-build-images](https://img.shields.io/docker/image-size/slicer/slicer-build/latest)](https://hub.docker.com/r/slicer/slicer-build)
18+
An image containing a Slicer build tree along with all the
19+
dependencies to build Slicer.
620

7-
- slicer/slicer-dependencies
8-
[![slicer-dependencies-images](https://img.shields.io/docker/image-size/slicer/slicer-dependencies/latest)](https://hub.docker.com/r/slicer/slicer-dependencies)
9-
An image containing all the dependencies to build Slicer itself:
10-
ITK, VTK, CTK, Qt, etc.
21+
### slicer/slicer-test
1122

12-
- slicer/slicer-build
13-
[![slicer-build-images](https://img.shields.io/docker/image-size/slicer/slicer-build/latest)](https://hub.docker.com/r/slicer/slicer-build)
14-
An image containing a Slicer build tree along with all the
15-
dependencies to build Slicer.
23+
[![slicer-test-images](https://img.shields.io/docker/image-size/slicer/slicer-test/latest)](https://hub.docker.com/r/slicer/slicer-test)
24+
An image containing a Slicer build and test tree along with all the
25+
dependencies to build Slicer.
1626

17-
- slicer/slicer-test
18-
[![slicer-test-images](https://img.shields.io/docker/image-size/slicer/slicer-test/latest)](https://hub.docker.com/r/slicer/slicer-test)
19-
An image containing a Slicer build and test tree along with all the
20-
dependencies to build Slicer.
27+
### slicer/slicer-test:opengl
2128

22-
- slicer/slicer-test:opengl
23-
[![slicer-test-opengl-images](https://img.shields.io/docker/image-size/slicer/slicer-test/opengl)](https://hub.docker.com/r/slicer/slicer-test)
24-
An image based on thewtex/opengl:centos which contains configuration
25-
files to run Slicer's tests
29+
[![slicer-test-opengl-images](https://img.shields.io/docker/image-size/slicer/slicer-test/opengl)](https://hub.docker.com/r/slicer/slicer-test)
30+
An image based on thewtex/opengl:centos which contains configuration
31+
files to run Slicer's tests
2632

27-
# Usage
33+
## Usage
2834

2935
To build and package a local Slicer source tree at `~/src/Slicer`
3036
against pre-built dependencies:
@@ -36,7 +42,7 @@ docker cp slicer:$(docker cp slicer:/usr/src/Slicer-build/Slicer-build/PACKAGE_F
3642
docker rm slicer
3743
```
3844

39-
# Update
45+
## Update
4046

4147
To update the Slicer revision, first download Slicer sources:
4248

0 commit comments

Comments
 (0)