From ce1758a0dac61e970db0daeb27fc81c6ebbc7d00 Mon Sep 17 00:00:00 2001 From: illiliti Date: Thu, 30 Jan 2020 16:33:24 +0000 Subject: [PATCH] update readme --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d52e5aa..e0847b1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # initramfs -[WIP] Tiny initramfs +Just another one implemetation of initramfs + +### Features +- POSIX compliant +- Easy configuration without complexity +- LUKS detached header and keyfile +- LVM +- busybox mdev,mdevd and eudev are supported + +### Installation +Simply run as root generate script. Then move generated initramfs to /boot directory and update your bootloader + +### Dependencies +#### Basic +`busybox kmod util-linux` +#### Optional +`cryptsetup lvm2 device-mapper` + +### License +Licensed under GPLv3 + +Exceptions: + +The "mdev.conf" configuration file is modified version from "mdev-like-a-boss" project, Copyright (c) 2012-2020, Piotr Karbowski +Please consult the license notice in the file for terms and conditions. + +The "storage-device" script from "mdev-like-a-boss" project, Copyright (c) 2012-2020, Piotr Karbowski +Please consult the license notice in the file for terms and conditions.