Added more details to the README
This commit is contained in:
parent
7f158c9d66
commit
e71817759b
24
README.md
24
README.md
|
@ -4,6 +4,8 @@ An [8-bit stack-based computer](https://wiki.xxiivv.com/site/uxn.html), written
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
To build the Uxn emulator on Linux, you must have [SDL2](https://wiki.libsdl.org/).
|
To build the Uxn emulator on Linux, you must have [SDL2](https://wiki.libsdl.org/).
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
@ -12,6 +14,8 @@ To build the Uxn emulator on Linux, you must have [SDL2](https://wiki.libsdl.org
|
||||||
--cli # Run rom without graphics
|
--cli # Run rom without graphics
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Plan 9
|
||||||
|
|
||||||
To build the Uxn emulator on [9front](http://9front.org/), via [npe](https://git.sr.ht/~ft/npe):
|
To build the Uxn emulator on [9front](http://9front.org/), via [npe](https://git.sr.ht/~ft/npe):
|
||||||
|
|
||||||
```rc
|
```rc
|
||||||
|
@ -21,6 +25,26 @@ mk
|
||||||
If the build fails on 9front because of missing headers or functions,
|
If the build fails on 9front because of missing headers or functions,
|
||||||
try again after `rm -r /sys/include/npe`.
|
try again after `rm -r /sys/include/npe`.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Begin by building the assembler and emulator by running the build script.
|
||||||
|
|
||||||
|
```
|
||||||
|
./build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
```
|
||||||
|
bin/uxnasm projects/demos/life.usm bin/life.rom
|
||||||
|
```
|
||||||
|
|
||||||
|
To launch the rom:
|
||||||
|
|
||||||
|
```
|
||||||
|
bin/uxnemu bin/life.rom
|
||||||
|
```
|
||||||
|
|
||||||
## Emulator Controls
|
## Emulator Controls
|
||||||
|
|
||||||
- `ctrl+h` toggle debugger
|
- `ctrl+h` toggle debugger
|
||||||
|
|
2
build.sh
2
build.sh
|
@ -42,7 +42,7 @@ then
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "Assembling.."
|
echo "Assembling.."
|
||||||
./bin/uxnasm projects/demos/life.usm bin/boot.rom
|
./bin/uxnasm projects/demos/piano.usm bin/boot.rom
|
||||||
|
|
||||||
echo "Running.."
|
echo "Running.."
|
||||||
if [ "${2}" = '--cli' ];
|
if [ "${2}" = '--cli' ];
|
||||||
|
|
|
@ -187,7 +187,7 @@ RTN
|
||||||
DUP2 ,get-index JSR LDA
|
DUP2 ,get-index JSR LDA
|
||||||
SWP POP SWP
|
SWP POP SWP
|
||||||
MOD8
|
MOD8
|
||||||
SFT #01 AND
|
SFT MOD2
|
||||||
|
|
||||||
RTN
|
RTN
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue