Skip to content

Commit a4e4c6c

Browse files
committed
docs: add prebuilt images to readme [skip ci]
1 parent ebd14f4 commit a4e4c6c

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,31 @@ jobs:
148148
clangtidy: true # instead of `true`, which chooses the default version, you can pass a specific version.
149149
# ...
150150
```
151+
### Prebuilt Docker Images
152+
153+
To provide fast development environments, `setup-cpp` provides several prebuilt docker images that have the tools you need (e.g. `llvm, cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache`).
154+
155+
You can use these images as a base image for your project.
156+
157+
```dockerfile
158+
FROM aminya/setup-cpp-ubuntu-llvm:22.04-0.37.0 AS builder
159+
```
160+
161+
```dockerfile
162+
FROM aminya/setup-cpp-ubuntu-mingw:22.04-0.37.0 AS builder
163+
```
164+
165+
```dockerfile
166+
FROM aminya/setup-cpp-fedora-llvm:40-0.37.0 AS builder
167+
```
168+
169+
```dockerfile
170+
FROM aminya/setup-cpp-arch-llvm:base-0.37.0 AS builder
171+
```
172+
173+
The names are in the format `aminya/setup-cpp-<platform>-<compiler>:<platform_version>-<setup_cpp_version>`.
174+
175+
If you need to install the tools selectively, see the next section.
151176

152177
### Inside Docker
153178

0 commit comments

Comments
 (0)