From 3e69fa1f68dafd17dc95c36526da74112ab22f0e Mon Sep 17 00:00:00 2001 From: Jonathan Lebon Date: Thu, 25 Apr 2024 12:33:06 -0400 Subject: [PATCH] README.md: add a "Building" section Document how to build the base images locally. Link to relevant documentation pages. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index edf45c6..615dd22 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,25 @@ been extremely successful. This project aims to apply the same technique for bootable host systems - using standard OCI/Docker containers as a transport and delivery format for base operating system updates. +## Building + +First, the expectation is that most users will want to build *layered* images +on top of the official base images. See the documentation[5] for more info. + +Building the images in this repo can be done with `podman build` as with any +other application image (note that building with `docker` is not currently +supported). You need to enable some privileges for technical reasons. + +``` +podman build --security-opt=label=disable --cap-add=all --device /dev/fuse \ + -t localhost/fedora-bootc:40 -f Containerfile.fedora-40 +``` + +See `Containerfile.fedora-40` for more details. + +You are of course also free to fork, customize, and build base images yourself. +See this page[6] of the documentation for more information. + ## More information Documentation: @@ -24,3 +43,5 @@ Documentation: