1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..38ae8d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# UXNFB
+
+This is a port of the [UXN virtual machine][uxn] for Linux with zero
+dependencies. It renders the graphics using the linux framebuffer and input
+devices.
+
+[uxn]: https://wiki.xxiivv.com/site/uxn.html
+
+## Configuration
+
+The path for the input devices must be passed at compile time.
+
+```
+make MOUSE_PATH=/dev/input/mouse0 KBD_PATH=/dev/input/event20
+```