commit 7369f5fb5247b0ffb9357dd4badd2b7e5af88853
parent 15ffab9d84273ab91918bfe49c91e66d1af0504f
Author: neauoire <aliceffekt@gmail.com>
Date: Mon, 24 May 2021 21:23:59 -0700
Improved README
Diffstat:
M | README.md | | | 58 | +++++----------------------------------------------------- |
1 file changed, 5 insertions(+), 53 deletions(-)
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ An [8-bit stack-based computer](https://wiki.xxiivv.com/site/uxn.html), written
### Linux
-To build the Uxn emulator on Linux, you must have [SDL2](https://wiki.libsdl.org/).
+To build the Uxn emulator, you must have [SDL2](https://wiki.libsdl.org/).
```sh
./build.sh
@@ -27,13 +27,13 @@ try again after `rm -r /sys/include/npe`.
## Getting Started
-Begin by building the assembler and emulator by running the build script.
+Begin by building the assembler and emulator by running the build script. The assembler(`uxnasm`) and emulator(`uxnemu`) are created in the `bin` folder.
```
./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).
+This example will create the `life.rom` from the `life.usm` uxambly file, point to a different usm file to assemble a different rom. You can find additional roms [here](https://sr.ht/~rabbits/uxn/sources). To create a rom, from a [usm file](https://wiki.xxiivv.com/site/uxambly.html), use the following command:
```
bin/uxnasm projects/demos/life.usm bin/life.rom
@@ -50,54 +50,6 @@ bin/uxnemu bin/life.rom
- `ctrl+h` toggle debugger
- `alt+h` toggle zoom
-## Uxambly
+## Need a hand?
-Read more in the [Uxambly Guide](https://wiki.xxiivv.com/site/uxambly.html).
-
-```
-( dev/console )
-
-%RTN { JMP2r }
-
-( devices )
-
-|10 @Console [ &pad $8 &char $1 ]
-
-( init )
-
-|0100 ( -> )
-
- ,hello-word
-
- &loop
- ( send ) LDRk .Console/char DEO
- ( incr ) #01 ADD
- ( loop ) DUP ,&loop JCN
- POP
-
-BRK
-
-@hello-word "hello 20 "World!
-```
-
-## TODOs
-
-- Shortcut to export/import disk state
-
-## Palettes
-
-- `#6a03` `#4a0d` `#aa0c`, purple/cyan
-- `#a1f3` `#a14d` `#a16c`, grey-pink/teal
-- `#8c4b` `#884b` `#e8bb`, commodore64
-
-## Convert audio for Unx
-
-```sox sub202_C.wav -b 8 -c 1 -e signed output.raw```
-
-## Refs
-
-https://code.9front.org/hg/plan9front/file/a7f9946e238f/sys/src/games/nes/cpu.c
-http://www.w3group.de/stable_glossar.html
-http://www.emulator101.com/6502-addressing-modes.html
-http://forth.works/8f0c04f616b6c34496eb2141785b4454
-https://justinmeiners.github.io/lc3-vm/
+Find us in `#uxn`, on irc.esper.net