Browse code
Improved README
neauoire authored on 25/05/2021 04:23:59
Showing 1 changed files
| ... | ... |
@@ -6,7 +6,7 @@ An [8-bit stack-based computer](https://wiki.xxiivv.com/site/uxn.html), written |
| 6 | 6 |
|
| 7 | 7 |
### Linux |
| 8 | 8 |
|
| 9 |
-To build the Uxn emulator on Linux, you must have [SDL2](https://wiki.libsdl.org/). |
|
| 9 |
+To build the Uxn emulator, you must have [SDL2](https://wiki.libsdl.org/). |
|
| 10 | 10 |
|
| 11 | 11 |
```sh |
| 12 | 12 |
./build.sh |
| ... | ... |
@@ -27,13 +27,13 @@ try again after `rm -r /sys/include/npe`. |
| 27 | 27 |
|
| 28 | 28 |
## Getting Started |
| 29 | 29 |
|
| 30 |
-Begin by building the assembler and emulator by running the build script. |
|
| 30 |
+Begin by building the assembler and emulator by running the build script. The assembler(`uxnasm`) and emulator(`uxnemu`) are created in the `bin` folder. |
|
| 31 | 31 |
|
| 32 | 32 |
``` |
| 33 | 33 |
./build.sh |
| 34 | 34 |
``` |
| 35 | 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). |
|
| 36 |
+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: |
|
| 37 | 37 |
|
| 38 | 38 |
``` |
| 39 | 39 |
bin/uxnasm projects/demos/life.usm bin/life.rom |
| ... | ... |
@@ -50,54 +50,6 @@ bin/uxnemu bin/life.rom |
| 50 | 50 |
- `ctrl+h` toggle debugger |
| 51 | 51 |
- `alt+h` toggle zoom |
| 52 | 52 |
|
| 53 |
-## Uxambly |
|
| 53 |
+## Need a hand? |
|
| 54 | 54 |
|
| 55 |
-Read more in the [Uxambly Guide](https://wiki.xxiivv.com/site/uxambly.html). |
|
| 56 |
- |
|
| 57 |
-``` |
|
| 58 |
-( dev/console ) |
|
| 59 |
- |
|
| 60 |
-%RTN { JMP2r }
|
|
| 61 |
- |
|
| 62 |
-( devices ) |
|
| 63 |
- |
|
| 64 |
-|10 @Console [ &pad $8 &char $1 ] |
|
| 65 |
- |
|
| 66 |
-( init ) |
|
| 67 |
- |
|
| 68 |
-|0100 ( -> ) |
|
| 69 |
- |
|
| 70 |
- ,hello-word |
|
| 71 |
- |
|
| 72 |
- &loop |
|
| 73 |
- ( send ) LDRk .Console/char DEO |
|
| 74 |
- ( incr ) #01 ADD |
|
| 75 |
- ( loop ) DUP ,&loop JCN |
|
| 76 |
- POP |
|
| 77 |
- |
|
| 78 |
-BRK |
|
| 79 |
- |
|
| 80 |
-@hello-word "hello 20 "World! |
|
| 81 |
-``` |
|
| 82 |
- |
|
| 83 |
-## TODOs |
|
| 84 |
- |
|
| 85 |
-- Shortcut to export/import disk state |
|
| 86 |
- |
|
| 87 |
-## Palettes |
|
| 88 |
- |
|
| 89 |
-- `#6a03` `#4a0d` `#aa0c`, purple/cyan |
|
| 90 |
-- `#a1f3` `#a14d` `#a16c`, grey-pink/teal |
|
| 91 |
-- `#8c4b` `#884b` `#e8bb`, commodore64 |
|
| 92 |
- |
|
| 93 |
-## Convert audio for Unx |
|
| 94 |
- |
|
| 95 |
-```sox sub202_C.wav -b 8 -c 1 -e signed output.raw``` |
|
| 96 |
- |
|
| 97 |
-## Refs |
|
| 98 |
- |
|
| 99 |
-https://code.9front.org/hg/plan9front/file/a7f9946e238f/sys/src/games/nes/cpu.c |
|
| 100 |
-http://www.w3group.de/stable_glossar.html |
|
| 101 |
-http://www.emulator101.com/6502-addressing-modes.html |
|
| 102 |
-http://forth.works/8f0c04f616b6c34496eb2141785b4454 |
|
| 103 |
-https://justinmeiners.github.io/lc3-vm/ |
|
| 55 |
+Find us in `#uxn`, on irc.esper.net |