diff --git a/README.md b/README.md index 434f5872..538dcbbc 100644 --- a/README.md +++ b/README.md @@ -199,67 +199,93 @@ jobs: To provide fast development environments, `setup-cpp` provides several prebuilt docker images that have the tools you need. You can use these images as a base image for your project. -With `llvm` and `cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang` +The names are in the format `aminya/setup-cpp-:-` and `aminya/setup-cpp--:-`. + +#### Ubuntu Images + +Base image with `cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang` + +Image with `llvm` and the base tools: ```dockerfile FROM aminya/setup-cpp-ubuntu-llvm:22.04-0.46.2 AS builder ``` -```dockerfile -FROM aminya/setup-cpp-fedora-llvm:40-0.46.2 AS builder -``` - -```dockerfile -FROM aminya/setup-cpp-arch-llvm:base-0.46.2 AS builder -``` - -With `gcc` and `cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang` +Image with `gcc` and the base tools: ```dockerfile FROM aminya/setup-cpp-ubuntu-gcc:22.04-0.46.2 AS builder ``` -```dockerfile -FROM aminya/setup-cpp-fedora-gcc:40-0.46.2 AS builder -``` - -```dockerfile -FROM aminya/setup-cpp-arch-gcc:base-0.46.2 AS builder -``` - -With `mingw` and `cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang` +Image with `mingw` and the base tools: ```dockerfile FROM aminya/setup-cpp-ubuntu-mingw:22.04-0.46.2 AS builder ``` +#### Fedora Images + +
+ +Base image with `cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang` + +```dockerfile +FROM aminya/setup-cpp-fedora-base:40-0.46.2 AS builder +``` + +Image with `llvm` and the base tools: + +```dockerfile +FROM aminya/setup-cpp-fedora-llvm:40-0.46.2 AS builder +``` + +Image with `gcc` and the base tools: + +```dockerfile +FROM aminya/setup-cpp-fedora-gcc:40-0.46.2 AS builder +``` + +Image with `mingw` and the base tools: + +```dockerfile +FROM aminya/setup-cpp-fedora-mingw:40-0.46.2 AS builder +``` + +
+ +#### ArchLinux Images + +
+ +Base image with `cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang` + +```dockerfile +FROM aminya/setup-cpp-arch-base:base-0.46.2 AS builder +``` + +Image with `llvm` and the base tools: + +```dockerfile +FROM aminya/setup-cpp-arch-llvm:base-0.46.2 AS builder +``` + +Image with `gcc` and the base tools: + +```dockerfile +FROM aminya/setup-cpp-arch-gcc:base-0.46.2 AS builder +``` + +Image with `mingw` and the base tools: + ```dockerfile FROM aminya/setup-cpp-arch-mingw:base-0.46.2 AS builder ``` -With `cmake, ninja, task, vcpkg, python, make, cppcheck, gcovr, doxygen, ccache, conan, meson, cmakelang` +
-```dockerfile -FROM aminya/setup-cpp-ubuntu:22.04-0.46.2 AS builder -``` +### Custom Docker Images -```dockerfile -FROM aminya/setup-cpp-ubuntu:22.04-0.46.2 AS builder -``` - -```dockerfile -FROM aminya/setup-cpp-fedora:40-0.46.2 AS builder -``` - -```dockerfile -FROM aminya/setup-cpp-arch:base-0.46.2 AS builder -``` - -The names are in the format `aminya/setup-cpp-:-` and `aminya/setup-cpp--:-`. - -If you need to install the tools selectively, see the next section. - -### Inside Docker +If you need to install the tools selectively, you can create your own Docker image with the tools you need. Here is an example for using setup-cpp to make a builder image that has the Cpp tools you need.