From d6f110958881cad0f56f8fcd1a3fc72c2d579ee5 Mon Sep 17 00:00:00 2001
From: Manuel Thalmann <m@nuth.ch>
Date: Thu, 20 Jun 2024 15:50:20 +0200
Subject: [PATCH] Add an explanation to the `archiso` project

---
 README.md         | 10 +++++++---
 archiso/README.md | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 3 deletions(-)
 create mode 100644 archiso/README.md

diff --git a/README.md b/README.md
index 49802544..e887f018 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # PortValhalla
-Provides both scripts and descriptive texts explaining how to set up my personal experience on my private devices
+Provides both scripts and descriptive texts explaining how to set up my personal experience on my private devices.
 
-So far, scripts and explanations for the following devices have been added:
-  - [My Surface Book 2](./devices/ManuSurface/ManuSurfaceSetup.md)
+## Components
+This project is split into multiple separate projects for different purposes.
+Head over to the individual projects to find out more about them:
+
+  - [`archiso`](./archiso):  
+    Provides scripts for creating a hand tailored `.iso` for setting up Arch Linux on a machine
diff --git a/archiso/README.md b/archiso/README.md
new file mode 100644
index 00000000..3e7745b6
--- /dev/null
+++ b/archiso/README.md
@@ -0,0 +1,32 @@
+# archiso-valhalla
+Creates `.iso` files or PXE boot assets for setting up Arch Linux.
+
+## Usage
+This project is meant to be used on Arch Linux. However, configuration files are provided to use it on any Linux system (or WSL) with [Nix] installed.
+
+### Requirements
+#### Arch Linux
+If you are using Arch Linux, make sure that the `archiso` package is installed on your system:
+
+```sh
+sudo pacman -Syu archiso
+```
+
+#### Nix
+On any other Linux system with Nix installed, use `nix` to automatically set up a development shell with the necessary tools installed:
+
+```sh
+nix develop
+```
+
+### Creating a `.iso`
+To create a `.iso` file for installing Arch Linux, run the following command:
+
+```sh
+mkarchiso .
+```
+
+This will generate a `.iso` file in a new folder called `out`. This `.iso` file can be used for installing Arch Linux.
+
+<!--- References --->
+[Nix]: https://nixos.org