From 2a230ea26b789c3c5e1b26f2a9dc18ffd814a0c7 Mon Sep 17 00:00:00 2001
From: Emery Hemingway <ehmry@posteo.net>
Date: Tue, 24 Sep 2019 02:17:43 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d287aa7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# An overlayed Nixpkgs for the Genode OS framework
+
+This repo contains Nix expressions for building Genode with Nixpkgs and building
+Nixpkgs for Genode. At the moment the former is experimental and broken in many
+cases, the later is probably broken for all cases.
+
+## Toolchain
+
+The LLVM cross-compiler may useful already, Clang apparently builds Genode
+without serious problems. Bootstrapping GCC is not feasible.
+
+To compiler environment may be accessed via the `nix-shell` utility and the
+`genode.base` attribute defined here.
+
+```sh
+nix-shell «path-to-this-repo» -A genode.base
+```
+
+Bootstrapping the environment on a laptop can take hours.
+
+TODO: easy binary cache configuration