From 3a1ad3ad5338809fb51c696a954ca8212d117f9e Mon Sep 17 00:00:00 2001
From: Graham Christensen <graham@grahamc.com>
Date: Mon, 25 May 2020 22:17:40 -0400
Subject: [PATCH] hello

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e22c32e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# netboot.nix
+
+Alternative expressions for netboot.
+
+In the future, I'd like to structure this as a module, to easily
+turn on recursive Nix builds, or target a ZFS filesystem, etc.
+
+Also, the future should include tests in this repo.
+
+## Included Module Expressions
+
+* `./quickly.nix` uses recursive Nix to build the initrd and squashfs
+  filesystems more quickly, allowing for faster iteration of images.
+  Initial testing reduced build time from 5-10 minutes per image to
+  15-30 seconds.
+
+## Setting up recursive nix
+
+Setting up recursive Nix requires support on the build machine:
+
+```nix
+{ pkgs, ... }: {
+  nix = {
+    package = pkgs.nixUnstable;
+    systemFeatures = [ "recursive-nix" "kvm" "nixos-test" ];
+    extraOptions = ''
+      experimental-features = recursive-nix
+    '';
+  };
+}
+```