From 285a26072630e91f59a8dd685ffce8b01e894f4e Mon Sep 17 00:00:00 2001 From: Lukas Zapletal Date: Tue, 22 Jul 2025 15:06:54 +0200 Subject: [PATCH] readme: add missing deps and local dev section Adds missing dependencies for `make rpm` target in the README. Adds a section to the README for local development instructions. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 8ab47a39..3056e70f 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,23 @@ Testing requires additional software: * `pytest` +## Running locally + +The main binary is safe to run on your development machine with: + + python3 -m osbuild --libdir . + +To build an image: + + python3 -m osbuild --libdir . ./test/data/manifests/fedora-boot.json + +Every osbuild run uses a cache for downloaded files (sources) and, optionally, +checkpoints of artifacts built by stages and pipelines. By default, this is +kept in `.osbuild` (in the current working directory). The location of this +directory can be specified using the `--cache` option. + +For more information about the options and arguments, read [man pages](/docs). + ## Build Osbuild is a python script so it is not compiled. @@ -87,6 +104,7 @@ way to install it is to create the set of RPMs that contain all these components This can be done with the `rpm` make target, i.e: ```sh +sudo dnf builddep osbuild.spec make rpm ```