diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b293e8 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Niver system images generator + +This is the sources to build system images of Niver using mkosi. You can then use them with systemd-nspawn. + +This generator allows to build images for both Arch Linux and Debian Testing, you can replace `` by either `arch` or `debian` in the following examples. Note that mkosi may require tools that are not available on your distribution. + +You can generate a new image in `/var/lib/machines/niver-` by running `mkosi --force -d ` from this directory (`--force` will erase an already existing image). + +You will need to copy `mkosi.nspawn` into `/etc/systemd/nspawn/niver-.nspawn` to allow the container to use network without restrictions. + +You can then boot the container: +``` +machinectl start niver- +machinectl shell niver- +``` + +The full explanation of the structure in this repository can be found on the mkosi manpage. Here is a summary of what mkosi will do in this repository: + +1. Load configuration from `mkosi.default` and `mkosi.default.d//mkosi.default` +2. Add `mkosi.skeleton` +3. Install packages +4. Run `mkosi.prepare` +5. Add `mkosi.extra` +6. Run `mkosi.postinst`