aboutsummaryrefslogtreecommitdiff
diff options
from:
to:
context:
space:
mode:
authorGravatar Neal Gompa <ngompa@fedoraproject.org> 2025-04-02 08:20:13 -0400
committerGravatar Neal Gompa <ngompa@fedoraproject.org> 2025-04-02 08:20:14 -0400
commitd3770941dfa1583909d2fa64a3b613b5775bb786 (patch)
tree31020ebd9337c4793855482dad0465b84eac44d5
parent3589fa143ad0f7f82d51b4299411ffbb03c4832d (diff)
downloadkiwi-descriptions-d3770941dfa1583909d2fa64a3b613b5775bb786.tar.gz
kiwi-descriptions-d3770941dfa1583909d2fa64a3b613b5775bb786.zip
README: Declare needed packages and tested environments
This is not exhaustive, but does get users into the right environment to build images. We also indicate that this is only tested on Fedora Linux.
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0b17d36..49a8260 100644
--- a/README.md
+++ b/README.md
@@ -13,11 +13,14 @@ configurations that can be built.
## Image build quickstart
+This is generally tested and expected to run on the latest stable release of Fedora Linux.
+Other distributions may work, but there are no guarantees.
+
Set up your development environment and run the image build (substitute `<image_type>` and `<image_profile>` for the appropriate settings):
```bash
# Install kiwi
-[]$ sudo dnf --assumeyes install kiwi
+[]$ sudo dnf --assumeyes install kiwi kiwi-systemdeps distribution-gpg-keys
# Run the image build
[]$ sudo ./kiwi-build --kiwi-file=Fedora.kiwi --image-type=<image_type> --image-profile=<image_profile> --output-dir ./outdir
```