| ... | ... |
@@ -4,6 +4,8 @@ An [8-bit stack-based computer](https://wiki.xxiivv.com/site/uxn.html), written |
| 4 | 4 |
|
| 5 | 5 |
## Build |
| 6 | 6 |
|
| 7 |
+### Linux |
|
| 8 |
+ |
|
| 7 | 9 |
To build the Uxn emulator on Linux, you must have [SDL2](https://wiki.libsdl.org/). |
| 8 | 10 |
|
| 9 | 11 |
```sh |
| ... | ... |
@@ -12,6 +14,8 @@ To build the Uxn emulator on Linux, you must have [SDL2](https://wiki.libsdl.org |
| 12 | 14 |
--cli # Run rom without graphics |
| 13 | 15 |
``` |
| 14 | 16 |
|
| 17 |
+### Plan 9 |
|
| 18 |
+ |
|
| 15 | 19 |
To build the Uxn emulator on [9front](http://9front.org/), via [npe](https://git.sr.ht/~ft/npe): |
| 16 | 20 |
|
| 17 | 21 |
```rc |
| ... | ... |
@@ -21,6 +25,26 @@ mk |
| 21 | 25 |
If the build fails on 9front because of missing headers or functions, |
| 22 | 26 |
try again after `rm -r /sys/include/npe`. |
| 23 | 27 |
|
| 28 |
+## Getting Started |
|
| 29 |
+ |
|
| 30 |
+Begin by building the assembler and emulator by running the build script. |
|
| 31 |
+ |
|
| 32 |
+``` |
|
| 33 |
+./build.sh |
|
| 34 |
+``` |
|
| 35 |
+ |
|
| 36 |
+You now have the assembler(`uxnasm`) and the emulator(`uxnemu`). To create a rom, from a [usm file](https://wiki.xxiivv.com/site/uxambly.html), use the following command. This example will create the `life.rom` from the `life.usm` uxambly file, point to a different file or folder to assemble a different rom. You can find additional roms [here](https://sr.ht/~rabbits/uxn/sources). |
|
| 37 |
+ |
|
| 38 |
+``` |
|
| 39 |
+bin/uxnasm projects/demos/life.usm bin/life.rom |
|
| 40 |
+``` |
|
| 41 |
+ |
|
| 42 |
+To launch the rom: |
|
| 43 |
+ |
|
| 44 |
+``` |
|
| 45 |
+bin/uxnemu bin/life.rom |
|
| 46 |
+``` |
|
| 47 |
+ |
|
| 24 | 48 |
## Emulator Controls |
| 25 | 49 |
|
| 26 | 50 |
- `ctrl+h` toggle debugger |