From 67cb124e9c17a17a0e6ca0b98f13d966f70012b2 Mon Sep 17 00:00:00 2001
From: Daniel Maslowski <info@orangecms.org>
Date: Tue, 12 Dec 2023 22:44:41 +0100
Subject: [PATCH] add README with initial instructions

Signed-off-by: Daniel Maslowski <info@orangecms.org>
---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3d9360
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# u-root builder
+
+This repository holds no code and just builds [u-root](https://u-root.org)
+images via GitHub Actions.
+
+## Try it out
+
+Download a prebuilt u-root image from
+[releases](https://github.com/linuxboot/u-root-builder/releases):
+
+```sh
+curl -L -o u-root.cpio.xz https://github.com/linuxboot/u-root-builder/releases/download/v0.0.1/u-root_amd64_all.cpio.xz
+```
+
+Download a
+[kernel from Arch Linux](https://archlinux.org/packages/core/x86_64/linux/)
+and extract it:
+
+```sh
+curl -L -o linux.tar.zst https://archlinux.org/packages/core/x86_64/linux/download/
+tar -xf linux.tar.zst
+```
+
+Run it:
+
+```sh
+qemu-system-x86_64 -enable-kvm -machine q35 -nographic -append "console=ttyS0" \
+  -kernel usr/lib/modules/*/vmlinuz -initrd u-root.cpio.xz
+```
+
+Run a command:
+
+```sh
+uname -a
+```