initial commit

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..30913f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Zosimos
+
+experimenting with embedded Zig programming
+
+## Building
+
+This project has been tested with Zig version `0.15.0-dev.64+2a4e06bcb`
+
+```bash
+$ zig build
+```
+
+builds the kernel and sets up the `zig-out/boot` directory for network booting.
+The included `compose.yaml` file can then be used to start OpenOCD and a tftp
+server with the correct configuration for remotely debugging the pi.