From: Philip Molloy <philip@philipmolloy.com>
Date: Thu, 20 Feb 2025 13:49:26 +0000 (+0100)
Subject: README: Reference EXAMPLES and mkosi documentation
X-Git-Tag: v26~363
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f11f5fd7907d396801c31865e28d3aea8f887da8;p=thirdparty%2Fmkosi.git

README: Reference EXAMPLES and mkosi documentation

Generally, examples are a great way to get started with a new tool.
Additionally, there does not appear to be formal getting started
documentation for mkosi.
---

diff --git a/README.md b/README.md
index ba13ea3bb..fd3342234 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,9 @@ A fancy wrapper around `dnf --installroot`, `apt`, `pacman`
 and `zypper` that generates customized disk images with a number of
 bells and whistles.
 
-For a longer description and available features and options, see the
-[man page](mkosi/resources/man/mkosi.1.md).
+For a longer description and available features and options, see the [man
+page](mkosi/resources/man/mkosi.1.md) or run `mkosi documentation`. When
+getting started see the `EXAMPLES` section.
 
 <a href="https://repology.org/project/mkosi/versions">
     <img align="right" src="https://repology.org/badge/vertical-allrepos/mkosi.svg?exclude_sources=site&exclude_unsupported=1" alt="Packaging status">