From a4e4c6c3be2d005a86e49485f7265e904b1bd9b3 Mon Sep 17 00:00:00 2001
From: Amin Yahyaabadi <aminyahyaabadi74@gmail.com>
Date: Sun, 24 Mar 2024 01:20:42 -0700
Subject: [PATCH] docs: add prebuilt images to readme [skip ci]

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index b9051418..54913267 100644
--- a/README.md
+++ b/README.md
@@ -148,6 +148,31 @@ jobs:
           clangtidy: true # instead of `true`, which chooses the default version, you can pass a specific version.
           # ...
 ```
+### Prebuilt Docker Images
+
+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`).
+
+You can use these images as a base image for your project.
+
+```dockerfile
+FROM aminya/setup-cpp-ubuntu-llvm:22.04-0.37.0 AS builder
+```
+
+```dockerfile
+FROM aminya/setup-cpp-ubuntu-mingw:22.04-0.37.0 AS builder
+```
+
+```dockerfile
+FROM aminya/setup-cpp-fedora-llvm:40-0.37.0 AS builder
+```
+
+```dockerfile
+FROM aminya/setup-cpp-arch-llvm:base-0.37.0 AS builder
+```
+
+The names are in the format `aminya/setup-cpp-<platform>-<compiler>:<platform_version>-<setup_cpp_version>`.
+
+If you need to install the tools selectively, see the next section.
 
 ### Inside Docker