README: update documentation

master
BodgeMaster 2023-06-20 13:18:30 +02:00
parent edb0c96796
commit b4b73ef3f0
1 changed files with 43 additions and 12 deletions

View File

@ -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 This repository holds scripts for installing a Void Linux setup specialized to run off a USB stick.
Void Linux 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 dont 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 - Set up a Void live medium
- Download here: https://voidlinux.org/download/ - Download here: https://voidlinux.org/download/
- The following instructions assume you downloaded the "base" image - 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. - Windows should have a built-in thing for burning ISOs.
- You can use something like Win32DiskImager or Rufus for USB sticks. - You can use something like Win32DiskImager or Rufus for USB sticks.
- This will delete whats on the stick. - This will delete whats on the stick.
- Boot into Void live and prepare things - Boot into Void live and prepare things
- Two things I cant help you with (sorry): - Things I cant help you with (sorry):
- How to boot off CD/USB depends on your computer, so youll have to find out elsewhere. - How to boot off CD/USB depends on your computer, so youll 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. - 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` - Log in as `root`, password `voidlinux`
- If you need to use WiFi, run `void-installer` - If you need to use WiFi, run `void-installer`
- set your keyboard layout (optional) - Set your keyboard layout (optional)
- connect to your network - Connect to your network
- abort the installation - Abort the installation (dont touch anything else)
- Download and run stage 1 of the USB installation script - Download and run stage 1 of the USB installation script
- The base image doesnt come with a way to download files so you need to install that first: `xbps-install -S wget` - The base image doesnt 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` - `wget https://lostcave.ddnss.de/git/BodgeMaster/void-minecraft-usb/raw/branch/master/install-stage1.sh`
- `bash 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