]> git.ipfire.org Git - thirdparty/mkosi.git/commitdiff
README: Reference EXAMPLES and mkosi documentation
authorPhilip Molloy <philip@philipmolloy.com>
Thu, 20 Feb 2025 13:49:26 +0000 (14:49 +0100)
committerDaan De Meyer <daan.j.demeyer@gmail.com>
Thu, 20 Feb 2025 14:00:53 +0000 (15:00 +0100)
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.

README.md

index ba13ea3bb9e066ec80a3f014637b33fbd91c6212..fd334223467bdeec145c33cc20d5ef8488594b99 100644 (file)
--- 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">