add some documentation

README.md

@@ -7,3 +7,36 @@
   - CCCHH Proxmox Address: https://10.31.210.248:8006/
 
 
+## VM Installation Instructions
+
+1. Create a new system configuration in the [systems/](./systems/) directory.
+   The default configuration (defined in [base_system.nix](./modules/base_system.nix) and [user_account.nix](./modules/user_account.nix)), which is automatically included, defines a `noc` user, filesystem configuration and some locale and nix settings.
+   For a basic installation, you should not need to actually add any relevant settings into your system config (see for reference [test.eh22.intern config](./systems/test.eh22.intern.nix).
+
+2. Add the new system configuration as flake output by including it at the bottom of [systems/default.nix](./systems/default.nix).
+
+3. Commit & Push your git changes.
+
+4. Create a new VM in Proxmox.
+   For our defaults to work, the system disk image should be added as scsi0 and BIOS-Boot should be used.
+
+   You should also add the `nixos-24.11-custom-installer.iso` in the VM's CD/DVD drive.
+
+5. Boot the installer and install the sytem.
+
+   Once the installer is booted and assuming that defaults are used, enter the following command to install a systems NixOS definition into the VM:
+
+   ```bash
+   sudo disko-install --disk system /dev/sda --flake "git+https://git.hamburg.ccc.de/EH22/nox.git#<your-system-name>"
+   ```
+
+6. Reboot into the installed system after installation has finished.
+
+   The VM can now further be configured using `./switch_remote.sh`.
+   See [VM Configuration](#vm-configuration) for details about this.
+
+
+## VM Configuration
+
+**TODO**
+