chore: add gui deps to README.md

chore: update nfd-zig
respond to build.zig changes in zig master
2023-02-04 19:30:55 -06:00 · 2023-02-04 19:30:42 -06:00 · 2023-02-04 19:30:42 -06:00 · 2023-02-04 19:30:42 -06:00 · 2023-02-04 19:30:42 -06:00 · 2023-02-04 19:30:42 -06:00
1 changed files with 8 additions and 6 deletions
--- a/README.md
+++ b/README.md
@ -13,7 +13,7 @@ This is a simple (read: incomplete) for-fun long-term project. I hope to get "mo
 - [x] Affine Sprites
 - [ ] Windowing (see [this branch](https://git.musuka.dev/paoda/zba/src/branch/window))
 - [ ] Audio Resampler (Having issues with SDL2's)
- [ ] Immediate Mode GUI
+- [x] Immediate Mode GUI (see [this branch](https://git.musuka.dev/paoda/zba/src/branch/imgui))
 - [ ] Refactoring for easy-ish perf boosts
 ## Usage
@ -84,24 +84,26 @@ Most recently built on Zig [v0.11.0-dev.1557+03cdb4fb5](https://github.com/zigla
 Dependency | Source
 --- | ---
 SDL.zig | <https://github.com/MasterQ32/SDL.zig>
 zig-clap | <https://github.com/Hejsil/zig-clap>
 known-folders | <https://github.com/ziglibs/known-folders>
-zig-toml | <https://github.com/aeronavery/zig-toml>
+nfd-zig | <https://github.com/fabioarnold/nfd-zig>
 zgui | <https://github.com/michal-z/zig-gamedev/tree/main/libs/zgui>
 zig-clap | <https://github.com/Hejsil/zig-clap>
 zig-datetime | <https://github.com/frmdstryr/zig-datetime>
 zig-toml | <https://github.com/aeronavery/zig-toml>
 `bitfields.zig` | [https://github.com/FlorenceOS/Florence](https://github.com/FlorenceOS/Florence/blob/aaa5a9e568/lib/util/bitfields.zig)
 `gl.zig` | <https://github.com/MasterQ32/zig-opengl>
-Use `git submodule update --init` from the project root to pull the git submodules `SDL.zig`, `zig-clap`, `known-folders`, `zig-toml` and `zig-datetime`
+Use `git submodule update --init` from the project root to pull the git relevant git submodules
 Be sure to provide SDL2 using:
 - Linux: Your distro's package manager
- MacOS: ¯\\\_(ツ)_/¯
+- MacOS: `brew` (install [this formula](https://formulae.brew.sh/formula/sdl2))
 - Windows: [`vcpkg`](https://github.com/Microsoft/vcpkg) (install `sdl2:x64-windows`)
 `SDL.zig` will provide a helpful compile error if the zig compiler is unable to find SDL2.
-Once you've got all the dependencies, execute `zig build -Drelease-fast`. The executable is located at `zig-out/bin/`.
+Once you've got all the dependencies, execute `zig build -Doptimize=ReleaseSafe`. The executable is located at `zig-out/bin/`.
 ## Controls
Author	SHA1	Message	Date
Rekai Nyangadzayi Musuka	c420fec3c6	chore: add gui deps to README.md	2023-02-04 19:30:55 -06:00
Rekai Nyangadzayi Musuka	7f01c079a4	chore: update nfd-zig respond to build.zig changes in zig master	2023-02-04 19:30:42 -06:00
Rekai Nyangadzayi Musuka	90f7a4f73a	feat: implement menu bar + add file picker dep	2023-02-04 19:30:42 -06:00
Rekai Nyangadzayi Musuka	b56b1b62d8	feat: show game title as imgui screen title	2023-02-04 19:30:42 -06:00
Rekai Nyangadzayi Musuka	ba200692c1	chore: update zgui	2023-02-04 19:30:42 -06:00
Rekai Nyangadzayi Musuka	8d639c1a8b	feat: add scheduler ui	2023-02-04 19:30:42 -06:00
Rekai Nyangadzayi Musuka	6c5f126ea6	feat: pause emu when UI reads emu state	2023-02-04 19:30:42 -06:00
Rekai Nyangadzayi Musuka	d396073142	feat: implement ui for register, interrupt	2023-02-04 19:30:41 -06:00
Rekai Nyangadzayi Musuka	42764b21ef	feat: add system information window	2023-02-04 19:30:41 -06:00
Rekai Nyangadzayi Musuka	1e6a8eec90	fix: update zgui to work with sdl2 vcpkg package	2023-02-04 19:30:41 -06:00
Rekai Nyangadzayi Musuka	ac82019fa0	feat: add imgui support using zgui	2023-02-04 19:30:41 -06:00
Rekai Nyangadzayi Musuka	fdf7399e52	chore: update README.md	2023-02-04 19:30:05 -06:00