From 707b6dac805bcc4f2b5e297ff3ce4b82538bcff0 Mon Sep 17 00:00:00 2001
From: Bad Diode <bd@badd10de.dev>
Date: Thu, 20 May 2021 17:02:47 +0200
Subject: Add README and some example roms

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..975201c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# UXNGBA
+
+This is a port of the [UXN virtual machine][uxn] for the GBA. It is currently at
+an early stage, but is capable of running simple demos that make use of the
+screen or console devices, including the beautiful DVD bouncing.
+
+[uxn]: https://wiki.xxiivv.com/site/uxn.html
+
+## Building from source
+
+To build this software you need the [devkitPro][devkitpro] SDK. Once installed,
+You may need to modify the Makefile to set up the path:
+
+```
+DEVKITPRO  := /opt/devkitpro
+DEVKITARM  := /opt/devkitpro/devkitARM
+PATH       := $(DEVKITARM)/bin:$(PATH)
+LIBGBA_DIR := $(DEVKITPRO)/libgba
+LIBGBA_SRC := /opt/devkitpro/libgba/include/
+LIBGBA     := $(LIBGBA_DIR)/lib/libgba.a
+LIBGBA     += $(LIBGBA_DIR)/lib/libfat.a
+LIBGBA     += $(LIBGBA_DIR)/lib/libmm.a
+```
+
+An intermediate build step will create a `src/uxn/roms/boot.c` file, for which
+you need the `bin2carr` utility that can be found [here][bin2carr].
+
+If everything is properly installed, you should be able to run `make` to compile
+the program into a `uxngba.gba` rom. If you have `mgba-qt` installed, you can
+test it with: `make run`.
+
+To use a specific UXN compiled rom, you can pass it as the `ROM_SRC` make
+parameter:
+
+```
+make run ROM_SRC=src/uxn/roms/piano.rom
+```
+
+[devkitpro]: https://devkitpro.org/
+[bin2carr]: https://git.badd10de.dev/gba-dev-tools/
-- 
cgit v1.2.1