From e7be641b16c8b854a7ba6321f2df994e72a4cdc0 Mon Sep 17 00:00:00 2001
From: Emil Lerch <emil@lerch.org>
Date: Mon, 8 Jul 2024 19:59:23 -0700
Subject: [PATCH] add a terrible starter README

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6e80df9..563b914 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
-(cd ziggy && zig build -Doptimize=ReleaseSafe -Dtarget=x86_64-linux-gnu.2.13 -Dcpu=baseline) && cp ziggy/zig-out/lib/libziggy.a . &&  kraft build --plat qemu --arch x86_64 --log-level debug --log-type basic && kraft run --pla
-t qemu --arch x86_64
+Native Unikraft Microkernel Build for Zig libraries
+===================================================
+
+This is an example repository, due to be cleaned up. For now, install Kraftkit
+and zig and build it this way:
+
+```sh
+(cd ziggy && zig build -Doptimize=ReleaseSafe -Dtarget=x86_64-linux-gnu.2.13 -Dcpu=baseline) && cp ziggy/zig-out/lib/libziggy.a . &&  kraft build --plat qemu --arch x86_64 --log-level debug --log-type basic && kraft run --plat qemu --arch x86_64
+```
+
+Only works on Linux, with QEMU (install that too!) and Zig 0.13.0 (though probably
+works on 0.12.0 as well).
+
+More to follow