From 0b4533c0dd3742fcd0a6b2fecb50162a14323507 Mon Sep 17 00:00:00 2001
From: BodgeMaster <>
Date: Tue, 27 Jun 2023 15:44:54 +0200
Subject: [PATCH] readme: update documentation

---
 README.md | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index bc6f47f..d7210ee 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,15 @@
 # Void Linux Setup for USB Sticks
 
+```
+     _________________________
+  .*¯ _  _        __ ___     /|_______
+ /   | |//,·¯¯*. / // _ \   //  //   /|
+|    | '// ( ) ;/ // // /  //  _¯   ///
+|    |_/ '.__.*/_//___.*  //  //   ///
+\*·…_____________________/’–––––––://
+ *·…_____________________|;–––––––'*
+```
+
 This repository holds scripts for installing a Void Linux setup specialized to run off a USB stick.
 
 This is only for USB sticks (thumb drives, pen drives, whatever you wanna call them).
@@ -54,9 +64,10 @@ The scripts will take it from there, asking you for information and downloading
 
 - `install-stage1.sh`: sets up the base system and prepares for installation stage 2
 - `install-stage2.sh`: continues setting up things after booting into the freshly installed base system
-- `opt/grub-config`: the custom grub config generator to be installed in /opt/void-usb
-- `opt/backup-fs`: helper script to regenerate the squashfs
+- `opt/`: contains files to be installed in /opt/void-usb/
+  - `grub-config`: custom grub config generator (probably not necessary but at this point I don’t wanna dig into the default one)
+  - `backup-fs`: helper script to rebuild the squashfs
+- `kernel.d/`: kernel hooks to be installed in /etc/kernel.d
 - `notes_to_self.txt`: will disappear once finished
-- `bootup.sh`: script that sets up the overlay
 - `bashrc`: just a custom bashrc
 - `update-squashfs.sh`: runs at shutdown, allows user to back up the system