commit 8af833aa02b22f93c63cee82bc31ac841b313d27
parent bd57e3634de7b07e1733d75320471c1aecf40cd8
Author: nanmi <nanmi@member.fsf.org>
Date: Tue, 21 Dec 2021 09:13:28 -0300
Minor grammar fixes and improvements on the README.md.
Diffstat:
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
# nanmi's initramfs
+Initramfs used on the late boot sequence (after the firmware loaded the bootloader; after the bootloader loaded the kernel; after the kernel is loaded), with the intent of using encrypted/verified drives with dm-crypt/dm-integrity and displayng a cute custom ASCII art to greet the user.
## Directory structure explanation
- bin/ - Needed to store binaries
@@ -17,13 +18,14 @@
## 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).
+ASCII art of Yotsuba, colored with ANSI escape code sequences (\033[32;01m) 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.
+ Used to replace hardcoded UUIDs on the init script with aliases set with [kernel parameters.](https://wiki.archlinux.org/title/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()
@@ -41,5 +43,6 @@ 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.
+## Further reading
All binaries are empty files only for illustration purposes.
Further reading: [https://wiki.gentoo.org/wiki/Custom_Initramfs](https://wiki.gentoo.org/wiki/Custom_Initramfs)
