commit bd57e3634de7b07e1733d75320471c1aecf40cd8 parent dfae6429b64734aaa0e2455a12ae21df16dc13df Author: nanmi <nanmi@member.fsf.org> Date: Tue, 21 Dec 2021 09:04:59 -0300 Add Needed Packages and Function explanations Diffstat:
| M | README.md | | | 32 | +++++++++++++++++++++++++++++++- |
1 file changed, 31 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md @@ -11,5 +11,35 @@ - sbin/ - Needed to store elevated binaries - sys/ - Needed to mount sysfs +## Needed packages +- sys-apps/busybox (statically linked) +- sys-fs/cryptsetup (statically linked) + +## Function structure explanation +### installGentoo() +ASCII art of Yotsuba, colored with ANSI escape code sequences (\033[32;01m)i and centered on a 1920x1080 resolution display with 101 whitespaces (%101s). + +### cmdline() +Used to replace hardcoded UUIDs on the init script with aliases set with kernel parameters. + +### setUp() +Prepare the initramfs enviroment. +**IMPORTANT!: The 1 second sleep is needed so the kernel can identify all devices before dinamically populating dev/. Not doing this while using devtmps might lead to kernel panics.** + +### preparestick() +Unlock and mount the USB drive containing the header and key-file used do decrypt the main disk. + +### prepareDisk() +Decrypt, verify the integrity and mount the disk. + +### closeStick() +Unmount and close the dm-crypt volume so it doesn't appear unlocked/mounted on startup. + +### cleanUp() +Tidy everything up before booting the real thing. + +### bootUp() +Utilize the /sbin/init contained in the main disk. The init script of the initramfs is no longer used. + All binaries are empty files only for illustration purposes. -Further reading: https://wiki.gentoo.org/wiki/Custom_Initramfs +Further reading: [https://wiki.gentoo.org/wiki/Custom_Initramfs](https://wiki.gentoo.org/wiki/Custom_Initramfs)