Explain the installation in the README

diff --git a/README.md b/README.md
index ed944eff90980f3018618467df91eb36a9c12161..c95b34265f77dee0df78b3b9abee624ab2450e52 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,31 @@ bells and whistles.
 For a longer description and available features and options, see the
 [man page](mkosi.md).
 
+# Installation
+
+Installing `mkosi` is easy, as it has no runtime Python dependencies (you will
+need all the tools to format filesystems and bootstrap the distribution
+appropriate for your image, though).
+
+If you just want the current master branch you can run
+```shell
+python3 -m pip install --user git+https://github.com/systemd/mkosi.git
+```
+
+If you want to hack on mkosi do
+```shell
+# clone either this repository or your fork of it
+git clone https://github.com/systemd/mkosi/
+cd mkosi
+python3 -m pip install --user --editable .
+```
+This will install mkosi in editable mode to `~/.local/bin/mkosi`, allowing you
+to use your own changes right away.
+
+For development you optionally also need [mypy](https://github.com/python/mypy)
+and [pytest](https://github.com/pytest-dev/pytest). We check tests and typing in
+CI (see `.github/workflows`), but you can run the tests locally as well.
+
 # References
 
 * [Primary mkosi git repository on GitHub](https://github.com/systemd/mkosi/)