From 07723b7022f9aeaadb323020e81b6fae673f0120 Mon Sep 17 00:00:00 2001
From: Tim Schubert <dadada@dadada.li>
Date: Sat, 28 Dec 2024 02:24:37 +0100
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6397da1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# UEFI Conway's Game of Life
+
+Conway's GOL in uefi-rs.
+
+## Run in QEMU
+
+Install the firmware files:
+
+Nix:
+
+```
+nix build nixpkgs#OVMF
+```
+
+Debian/Ubuntu:
+
+```
+sudo apt-get install qemu ovmf
+```
+
+Fedora:
+
+```
+sudo dnf install qemu-kvm edk2-ovmf
+```
+
+Then copy the firmware files to the project directory.
+
+Then run
+
+```
+./run.sh
+```