(m291) Added README

This commit is contained in:
Devine Lu Linvega 2024-08-31 10:53:04 -07:00
parent d16798dc7b
commit bf99790adb
1 changed files with 25 additions and 0 deletions

25
gui/m291/README.md Normal file
View File

@ -0,0 +1,25 @@
# m291
A music player, written in [Uxntal](https://wiki.xxiivv.com/site/uxntal.html).
## Build
You must have the [Uxn11](https://git.sr.ht/~rabbits/uxn/) assembler and emulator.
```sh
uxnasm src/m291.tal bin/m291.rom
```
## Usage
The following command will read a `tal` file and raise warnings if optimizations can be found.
```sh
ux11 bin/m291.rom
```
## Extras
- [Need a hand?](https://llllllll.co/t/uxn-virtual-computer/46103)
- Linted with [uxnlin](https://git.sr.ht/~rabbits/uxnlin)
- Assembled with [drifblim](https://git.sr.ht/~rabbits/drifblim)