mirror of https://git.sr.ht/~rabbits/drifblim
Added docs
This commit is contained in:
parent
9d525ff4b5
commit
cc49496346
27
README.md
27
README.md
|
@ -6,7 +6,11 @@ The assembler is written in about 400 lines, it's designed to help bootstrap the
|
|||
|
||||
### Project
|
||||
|
||||
- `drifblim.tal` Self-hosted assembler.
|
||||
- `procblim.tal` Pre-processor.
|
||||
- `drifblim.tal` Assembler.
|
||||
|
||||
#### Extras
|
||||
|
||||
- `unicycle.tal` Console REPL.
|
||||
- `bicycle.tal` [Graphical REPL](https://wiki.xxiivv.com/bicycle).
|
||||
|
||||
|
@ -15,25 +19,18 @@ The assembler is written in about 400 lines, it's designed to help bootstrap the
|
|||
This assembler is written in the language it is assembling, creating a chicken-and-egg problem. You have two choices, download a pre-assembled [drifblim.rom](https://rabbits.srht.site/drifblim/drifblim.rom)(1300 bytes), or use [uxnasm.c](https://git.sr.ht/~rabbits/uxn/tree/main/item/src/uxnasm.c).
|
||||
|
||||
```sh
|
||||
# from uxnasm
|
||||
# start with uxnasm
|
||||
uxnasm src/drifblim.tal bin/drifblim.rom
|
||||
# from drifblim.rom
|
||||
uxncli bin/drifblim.rom src/drifblim.tal
|
||||
# Pre-processor for macros
|
||||
uxncli bin/procblim.rom etc/hello.tal
|
||||
# Assembling hello.tal
|
||||
uxncli bin/drifblim.rom etc/hello.pro.tal
|
||||
mv etc/hello.pro.rom bin/hello.rom
|
||||
uxncli bin/hello.rom
|
||||
```
|
||||
|
||||
If do not wish to assemble it yourself, you can download [drifblim.rom](https://rabbits.srht.site/drifblim/drifblim.rom).
|
||||
|
||||
## Manual
|
||||
|
||||
- `LIST` Displays a list of all available routines.
|
||||
- `PRINT/PRINT2` Prints the value at the top of the stack.
|
||||
- `MOD/MOD2` Pushes the modulo of X and Y, onto the stack.
|
||||
- `ABS/ABS2` Pushes the absolute value of X, onto the stack.
|
||||
- `RAND/RAND2` Pushes a random value between 0 and X, onto the stack.
|
||||
- `QUIT` Turns off the system.
|
||||
|
||||
## Controls
|
||||
|
||||
- `mouse2` Inject mouse position into input.
|
||||
|
||||
_Drifblim is strong enough to lift Pokémon or people but has no control over its flight. This causes it to drift with the wind and end up anywhere._
|
||||
|
|
Loading…
Reference in New Issue