aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
from:
to:
context:
space:
mode:
authorGravatar Neal Gompa <ngompa@fedoraproject.org> 2023-10-14 15:21:23 -0400
committerGravatar Neal Gompa <ngompa@fedoraproject.org> 2023-10-14 15:21:23 -0400
commit838cd9b2eef8e210a46a51b0cd77dfee5d595635 (patch)
tree0fabc7fe6f90aaedc77d338c62414b4005cf7f29 /README.md
parent14e2f2a0e1b4cca43e00d4f354be04378e1e78b0 (diff)
downloadkiwi-descriptions-838cd9b2eef8e210a46a51b0cd77dfee5d595635.tar.gz
kiwi-descriptions-838cd9b2eef8e210a46a51b0cd77dfee5d595635.zip
Initial import of descriptions
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 248842b..ef7ad42 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,23 @@ The `rawhide` branch is used for Fedora Rawhide images and each release branch i
All changes should be made via the PR workflow.
+## Image variants
+
+* Cloud Edition (image type: `oem`, image profiles: `Cloud-OpenStack`/`Cloud-AmazonEC2`/`Cloud-Azure`/`Cloud-GCE`)
+* Workstation Edition (image type: `iso`, image profiles: `Workstation-Live`)
+* KDE Spin (image type: `iso`, image profiles: `KDE-Live`)
+
+## Image build quickstart
+
+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
+# Run the image build
+[]$ sudo ./kiwi-build --image-type=<image_type> --image-profile=<image_profile> --output-dir ./outdir
+```
+
## Licensing
This is free software: you can redistribute it and/or modify