Reformat README to use Markdown and update contents

1 files changed, 42 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7e57cdd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# nipsy's NixOS configuration
+
+This repository is the starting point for storing all relevant NixOS configurations.
+
+## richese
+
+This host is currently assumed to be a VirtualBox VM.  The VirtualBox VM should be configured with the following:
+
+CPU
+:As many physical (non-SMT) cores as your CPU has ideally, since NixOS does need to build things occasionally.
+
+RAM
+:8GB is probably a good starting point.  If the installer hangs, you probably need to increase this from the presumably lower value you have set.
+
+Display
+:The NixOS configuration assumes VMSVGA.
+
+Storage
+:The installer assumes you've selected an AHCI SATA controller using a dynamically allocated VDI of 100GB.  This might need to be bigger, given how disk intensive NixOS can be.
+
+Network
+:My testing NIC was configured in VirtualBox to use NAT and virtio-net.
+
+Other
+:This configuration works best if you also enable the bidirectional shared clipboard functionality under General -> Advanced.
+
+### Installation
+
+You can download the minimal ISO image from https://nixos.org/download/ to start.  Once in the installer command line, you can grab this repo using:
+
+```
+curl -O https://arrakis.bitgnome.net/nipsy/git/nix/snapshot/nix-master.tar.zst
+tar xavf nix-master.tar.zst
+```
+
+To start the installation script, including provisioning the local storage via disko, run:
+
+```
+nix-master/scripts/install-with-disko richese
+```
+
+which should walk you through the rest of the installation.