diff --git a/README.md b/README.md index b2c78c9..ff8d4d3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # zlevis-mkinitfs -A [mkinitfs](https://gitlab.alpinelinux.org/alpine/mkinitfs) module that implements automatic decryption of a `ZFS` root pool in the `initramfs` with `zlevis`. \ No newline at end of file +A [mkinitfs](https://gitlab.alpinelinux.org/alpine/mkinitfs) module that implements automatic decryption of a `ZFS` root pool in the `initramfs` with `zlevis`. + +## Installation + +`zlevis-mkinitfs` can be installed with `meson`, after cloning the repository, setup the build directory: + +``` shell-session +sh$ meson setup builddir +``` + +> Using the `--reconfigure` flag will reconfigure the build directory. + +Installation of the `zlevis-mkinitfs` module is now performed with: + +``` shell-session +sh# meson install -C builddir +```