ref: 6849c5f44ed85e90478ef960bc337c7c06336046
parent: 83dd78258053cd102e8425beb159a2be7e6b912f
author: Ain <41307858+nero@users.noreply.github.com>
date: Thu Aug 9 16:32:26 CDT 2018
Add README to help with manual building
--- /dev/null
+++ b/README.md
@@ -1,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.