From d1386e14f8af59356458fb2d1d4deffc25d56447 Mon Sep 17 00:00:00 2001 From: Ry Date: Sun, 24 Jul 2022 20:57:15 -0700 Subject: [PATCH] Add note about prebuilt binaries to the README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26241b3..a921f8b 100644 --- a/README.md +++ b/README.md @@ -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.