readme: update documentation

master
BodgeMaster 2023-06-27 15:44:54 +02:00
parent 7ad70c5d07
commit 0b4533c0dd
1 changed files with 14 additions and 3 deletions

View File

@ -1,5 +1,15 @@
# Void Linux Setup for USB Sticks # Void Linux Setup for USB Sticks
```
_________________________
.*¯ _ _ __ ___ /|_______
/ | |//,·¯¯*. / // _ \ // // /|
| | '// ( ) ;/ // // / // _¯ ///
| |_/ '.__.*/_//___.* // // ///
\*·…_____________________/://
*·…_____________________|;'*
```
This repository holds scripts for installing a Void Linux setup specialized to run off a USB stick. 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). 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-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 - `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/`: contains files to be installed in /opt/void-usb/
- `opt/backup-fs`: helper script to regenerate the squashfs - `grub-config`: custom grub config generator (probably not necessary but at this point I dont 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 - `notes_to_self.txt`: will disappear once finished
- `bootup.sh`: script that sets up the overlay
- `bashrc`: just a custom bashrc - `bashrc`: just a custom bashrc
- `update-squashfs.sh`: runs at shutdown, allows user to back up the system - `update-squashfs.sh`: runs at shutdown, allows user to back up the system