Some more tweaking to the installer, bake packages into the image

1 files changed, 41 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..84684e8
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,41 @@
+# Voussoir, an Arch Linux installer and rescue system
+
+Really, it's just an install script and ISO with some extra flair
+
+
+## Building an ISO
+
+From the base of the repository:
+
+```bash
+$ ./mkrepo.sh
+$ sudo ./mkiso.sh
+```
+
+Note, you may wish to clean your pacman cache (`pacman -Scc`) if you want it to
+skip downloading packages from upstream mirrors. 
+
+## Installing from the ISO
+
+Open a terminal and type `sudo install.sh`, follow the prompts.
+
+Once you reboot into your new system, run `sudo setup.sh` to make sure snapshots
+are properly enabled.
+
+## Notes:
+
+Installer assumes you want the entire disk wiped with encrypted btrfs root
+and snapshotting. 
+
+The installer has a lot of prompts especially towards the end where the AUR is
+used more heavily, you should be able to just hit "enter" on them for the most
+part.
+
+All the regular Arch Linux install tools should be available to you if you'd
+like to do something custom instead.
+
+
+## Todo:
+
+Remove the aur building and post install script. Shouldn't be too difficult
+to build the packages into the ISO, but I haven't bothered to yet.