From b4b73ef3f0b4290e9bd0a628640b9b94a53f7a6f Mon Sep 17 00:00:00 2001
From: BodgeMaster <>
Date: Tue, 20 Jun 2023 13:18:30 +0200
Subject: [PATCH] README: update documentation

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 43 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 47c9905..dd9ef78 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,61 @@
-# Void Linux Minecraft Setup for USB Sticks
+# Void Linux Setup for USB Sticks
 
-This repository holds a bunch of scripts for installing and customizing
-Void Linux to run off a USB stick.
+This repository holds scripts for installing a Void Linux setup specialized to run off a USB stick.
 
-There are a couple manual steps to get started before this script can take over:
+This is only for USB sticks (thumb drives, pen drives, whatever you wanna call them).
+You don’t need this if you want to use a USB HDD or SSD because these devices tend to just work normally.
+If you want to use a USB HDD/SSD, just download the installer for the Linux distro of your choice and
+install it on that drive. Most modern distros know how to cope with external drives.
+
+The reason this is useful for USB sticks is that most of them are a bit shit.
+Trying to run an operating system off a USB drive typically results in a corrupted drive pretty quickly
+(if you can get the system to install properly in the first place).
+
+## Installation
+
+You need the following:
+- Computer (duh)
+  - 8G of RAM or more
+  - Can boot off USB (most computers made after 2003)
+- USB stick (at least 8G)
+- Internet connection
+
+There are a couple manual steps to get started before the installer scripts can take over:
 - Set up a Void live medium
   - Download here: https://voidlinux.org/download/
     - The following instructions assume you downloaded the "base" image
-  - Burn to a CD/DVD or flash it to a USB stick
+  - Burn to CD/DVD or flash it to USB stick
     - Windows should have a built-in thing for burning ISOs.
     - You can use something like Win32DiskImager or Rufus for USB sticks.
       - This will delete what’s on the stick.
 - Boot into Void live and prepare things
-  - Two things I can’t help you with (sorry):
+  - Things I can’t help you with (sorry):
     - How to boot off CD/USB depends on your computer, so you’ll have to find out elsewhere.
     - Be aware that Void uses a US keymap until you change it. If your keyboard is different, you might need to look up an image of a US keyboard to find the right keys.
-  - If you are booting off the USB stick you want to install to, use the (RAM) option.
+  - If booting off the USB stick you want to install to, use (RAM) option
   - Log in as `root`, password `voidlinux`
   - If you need to use WiFi, run `void-installer`
-    - set your keyboard layout (optional)
-    - connect to your network
-    - abort the installation
+    - Set your keyboard layout (optional)
+    - Connect to your network
+    - Abort the installation (don’t touch anything else)
 - Download and run stage 1 of the USB installation script
   - The base image doesn’t come with a way to download files so you need to install that first: `xbps-install -S wget`
-    - if it yells at you about updating xbps, do that, then try again
+    - If it yells at you about updating xbps, do that, then try again
   - `wget https://lostcave.ddnss.de/git/BodgeMaster/void-minecraft-usb/raw/branch/master/install-stage1.sh`
   - `bash install-stage1.sh`
 
-The script will take it from there, asking you for information as needed.
+The scripts will take it from there, asking you for information and downloading things as needed.
+
+## How It Works
+
+`//TODO:` Add detailed documentation
+
+## Files
+
+- `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
+- `procedure.txt`: notes to self, 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