diff options
-rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9edca29 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# mkinitfs + +This is the initramfs generator for Alpine Linux, including support for apk and +Alpine Diskless boot. + +## Dependencies + +To compile manually, you need to have the following build tools available: + +- make +- gcc with musl and kernel-headers + +nlplug-findfs will link against the following libraries (runtime deps): + +- libkmod +- libblkid (from util-linux) +- libcryptsetup + +## Installation + +Build mkinitfs via `make` and install it via `make install`. +The installation honours the `DESTDIR` parameter to overwrite the sysroot path. + +For testing, its not necessary to install `mkinitfs` into your root file system. + +## Tweaking + +The Makefile is kept slim and debuggable. |