xenia/fox32
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add note about prebuilt binaries to the README

Browse Source
This commit is contained in:
Ry 2022-07-24 20:57:15 -07:00
parent dfadccd68c
commit d1386e14f8
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -10,13 +10,15 @@
**Note: This software is still very much in an early stage, and is currently more focused towards developers rather than end-users.**
Prebuilt binaries are available on the [GitHub Actions page](https://github.com/fox32-arch/fox32/actions).
### Building
Simply run `cargo build --release`. The resulting binary will be saved as `target/release/fox32`. You can also run `cargo run --release` if you want to run it directly.
### Usage
**fox32** attempts to read its ROM from a file called `fox32.rom` in the current directory. If this file isn't found then it falls back to `../fox32rom/fox32.rom`, and if this file isn't found then it exits.
**fox32** attempts to read its ROM (called **fox32rom**) from a file called `fox32.rom` in the current directory. If this file isn't found then it falls back to `../fox32rom/fox32.rom`, and if this file isn't found then it exits. **fox32rom** can be found [here](https://github.com/fox32-arch/fox32rom).
Passing files as arguments will mount those files as disks, in the order that the arguments were passed.