diff options
| author | Bad Diode <bd@badd10de.dev> | 2022-10-13 18:37:43 +0200 |
|---|---|---|
| committer | Bad Diode <bd@badd10de.dev> | 2022-10-13 18:37:43 +0200 |
| commit | fc3a2ea8357cfc9933ff8c91438a4d5eca3bfff9 (patch) | |
| tree | 8ebeea56b26b42b49f7947eb18c54dd0ca349e4f /README.md | |
| parent | 96e8dff73af09b5e9542e924ef4881fe01e436bf (diff) | |
| download | uxnfb-main.tar.gz uxnfb-main.zip | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
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 @@ | |||
| 1 | # UXNFB | ||
| 2 | |||
| 3 | This is a port of the [UXN virtual machine][uxn] for Linux with zero | ||
| 4 | dependencies. It renders the graphics using the linux framebuffer and input | ||
| 5 | devices. | ||
| 6 | |||
| 7 | [uxn]: https://wiki.xxiivv.com/site/uxn.html | ||
| 8 | |||
| 9 | ## Configuration | ||
| 10 | |||
| 11 | The path for the input devices must be passed at compile time. | ||
| 12 | |||
| 13 | ``` | ||
| 14 | make MOUSE_PATH=/dev/input/mouse0 KBD_PATH=/dev/input/event20 | ||
| 15 | ``` | ||