aboutsummaryrefslogtreecommitdiff
diff options
from:
to:
context:
space:
mode:
authorGravatar Neal Gompa <ngompa@fedoraproject.org> 2024-01-13 14:44:50 -0500
committerGravatar Neal Gompa <ngompa@fedoraproject.org> 2024-01-13 16:39:49 -0500
commited9fd4f4f77f1528d0ceadc7b0c01fd77a2cb87d (patch)
tree12bffd019b093ee5e0503269f51589e4edda0057
parentc41b562b1008bb01afcd724515589dacd00c12c2 (diff)
downloadkiwi-descriptions-ed9fd4f4f77f1528d0ceadc7b0c01fd77a2cb87d.tar.gz
kiwi-descriptions-ed9fd4f4f77f1528d0ceadc7b0c01fd77a2cb87d.zip
Split documentation of variants into its own file
As the list of buildable variants grows, it will be harder to maintain in the main README. Thus, split it out to its own file to keep the README manageable.
-rw-r--r--README.md8
-rw-r--r--VARIANTS.md9
2 files changed, 11 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6e93070..a36c6fb 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,8 @@ All changes should be made via the PR workflow.
## Image variants
-* Base Cloud Edition for clouds (image type: `oem`, image profiles: `Cloud-Base-Generic`/`Cloud-Base-AmazonEC2`/`Cloud-Base-Azure`/`Cloud-Base-GCE`)
-* Base Cloud Edition for Vagrant (image type: `oem`, image profiles: `Cloud-Base-Vagrant-libvirt`/`Cloud-Base-Vagrant-VirtualBox`)
-* Base Container (image type: `tbz`, image profiles `Container-Base-Generic-Minimal`/`Container-Base-Generic`)
-* Toolbox Container (image type: `tbz`, image profiles `Container-Toolbox`)
-* KDE Spin (image type: `iso`, image profiles: `KDE-Live`)
-* Workstation Edition (image type: `iso`, image profiles: `Workstation-Live`)
+Please look at [`VARIANTS`](/VARIANTS.md) for details on the available
+configurations that can be built.
## Image build quickstart
diff --git a/VARIANTS.md b/VARIANTS.md
new file mode 100644
index 0000000..95c6f8f
--- /dev/null
+++ b/VARIANTS.md
@@ -0,0 +1,9 @@
+## Image variants
+
+* Base Cloud Edition for clouds (image type: `oem`, image profiles: `Cloud-Base-Generic`/`Cloud-Base-AmazonEC2`/`Cloud-Base-Azure`/`Cloud-Base-GCE`)
+* Base Cloud Edition for Vagrant (image type: `oem`, image profiles: `Cloud-Base-Vagrant-libvirt`/`Cloud-Base-Vagrant-VirtualBox`)
+* Base Container (image type: `tbz`, image profiles `Container-Base-Generic-Minimal`/`Container-Base-Generic`)
+* Toolbox Container (image type: `tbz`, image profiles `Container-Toolbox`)
+* KDE Spin (image type: `iso`, image profiles: `KDE-Live`)
+* Workstation Edition (image type: `iso`, image profiles: `Workstation-Live`)
+