From 351a687a2d494c2dc79be0d31f5d6bede047b7fe Mon Sep 17 00:00:00 2001 From: Rekai Musuka Date: Fri, 21 Oct 2022 05:12:24 -0300 Subject: [PATCH] chore: update README.md --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9b9d07f..9242e2c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ An in-progress Gameboy Advance Emulator written in Zig ⚡! - [x] [`thumb.gba`](https://github.com/jsmolka/gba-tests/tree/master/thumb) - [x] [`armwrestler-gba-fixed.gba`](https://github.com/destoer/armwrestler-gba-fixed) - ## Resources * [GBATEK](https://problemkaputt.de/gbatek.htm) * [TONC](https://coranac.com/tonc/text/toc.htm) @@ -14,13 +13,34 @@ An in-progress Gameboy Advance Emulator written in Zig ⚡! * [ARM7TDMI Data Sheet](https://www.dca.fee.unicamp.br/cursos/EA871/references/ARM/ARM7TDMIDataSheet.pdf) ## Compiling -Most recently built on Zig [v0.10.0-dev.662+e139c41fd](https://github.com/ziglang/zig/tree/e139c41fd8955f873615b2c2434d162585c0e44c) +Most recently built on Zig [v0.10.0-dev.1037+331cc810d](https://github.com/ziglang/zig/tree/331cc810d) ### Dependencies * [SDL.zig](https://github.com/MasterQ32/SDL.zig) * [SDL2](https://www.libsdl.org/download-2.0.php) * [zig-clap](https://github.com/Hejsil/zig-clap) +* [`bitfields.zig`](https://github.com/FlorenceOS/Florence/blob/f6044db788d35d43d66c1d7e58ef1e3c79f10d6f/lib/util/bitfields.zig) -On windows, it's easiest if you use [`vcpkg`](https://github.com/Microsoft/vcpkg) to install `sdl2:x64-windows`. +`bitfields.zig` from [FlorenceOS](https://github.com/FlorenceOS) is included under `lib/util/bitfield.zig`. -Once you've installed all the dependencies, run `zig build -Drelease-fast`. The executable is located at `zig-out/bin/`. \ No newline at end of file +`SDL.zig` and `zig-clap` are git submodules you can init using `git submodule update --init` from your terminal. + +On Linux, be sure to have SDL2 installed using whatever package manager your distro uses. + +On Windows, it's easiest if you use [`vcpkg`](https://github.com/Microsoft/vcpkg) to install `sdl2:x64-windows`. If not, +`SDL2.zig` will provide a helpful compile error which should help you get what you need. + +On macOS? ¯\\\_(ツ)_/¯ I hope it isn't too hard to compile though. + +Once you've got all the dependencies, run `zig build -Drelease-fast`. The executable is located at `zig-out/bin/`. + +## Controls +Key | Button +--- | --- +X | A +Z | B +A | Left Shoulder +S | Right Shoulder +Return | Start +RShift | Select +Arrow Keys | D-Pad