From 8f8d2737436787d67029463d3e50ccbeb47a20a1 Mon Sep 17 00:00:00 2001 From: illiliti Date: Sun, 9 Feb 2020 21:13:39 +0000 Subject: [PATCH] update readme --- README.md | 44 +++++++++++++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e54eb5c..eb1f5d9 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,41 @@ # initramfs Just another one implemetation of initramfs -### Features -- POSIX compliant -- Easy configuration without complexity -- LUKS detached header and keyfile +Features +-------- +- POSIX compliance +- Easy configuration +- LUKS - LVM -- busybox mdev,mdevd and eudev +- mdev,mdevd and eudev -### Installation -Simply run as root generate script. Then move generated initramfs to /boot directory and update your bootloader +Dependencies +------------ +### Basic +``` +busybox +kmod +``` +### Optional +``` +cryptsetup - LUKS support +lvm2 - LVM support +util-linux - PARTUUID support +``` -### Dependencies -#### Basic -`busybox kmod util-linux` -#### Optional -`cryptsetup lvm2 device-mapper` +Installation +------------ +``` +git clone https://github.com/illiliti/initramfs +cd initramfs +``` -### License +Configuration +------------- +TODO + +License +------- Licensed under GPLv3 Exceptions: