blob: 15f19f1c31fdc5fd14728a50fdcd042ba11f746a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
From 6849c5f44ed85e90478ef960bc337c7c06336046 Mon Sep 17 00:00:00 2001
From: Ain <41307858+nero@users.noreply.github.com>
Date: Thu, 9 Aug 2018 21:32:26 +0200
Subject: [PATCH 3/5] Add README to help with manual building
---
README.md | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
create mode 100644 README.md
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.
--
2.18.0
|
