From 70abfd453c1da75abb19fa595040117a0b9581b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com> Date: Tue, 15 Nov 2022 08:55:51 +0000 Subject: [PATCH] docs: better doc structure --- README.md | 43 ++++++------------------------------------- doc/inspiration.md | 0 2 files changed, 6 insertions(+), 37 deletions(-) create mode 100644 doc/inspiration.md diff --git a/README.md b/README.md index 68c5b297..55d2c83e 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,14 @@ A Game Boy emulator that is written in Rust 🦀. * Support for multiple MBCs: MBC1, MBC2, MBC3, and MBC5 * Variable CPU clock speed -For the web front-end... +For the Web front-end... * Mobile first experience * Transparent RAM saving using [Web Storage API](https://developer.mozilla.org/docs/Web/API/Window/localStorage) * GamePad support using [Web Gamepad API](https://developer.mozilla.org/docs/Web/API/Gamepad_API) -* Unobstructive on-screen GamePad +* Unobstructive and effective on-screen GamePad * Cool bespoke display palettes built by [TheWolfBunny64](https://www.deviantart.com/thewolfbunny). -* Fullscreen mode +* Fullscreen browser mode * Debug mode - VRAM and registers ## Deployments @@ -67,41 +67,10 @@ You can use some GET parameters to control the initial behaviour of the emulator The palettes offered in the web version were provided by [TheWolfBunny64](https://www.deviantart.com/thewolfbunny). -## Inspiration +### Inspiration -### Documentation - -* [Game Boy Development community](https://gbdev.io/) -* [Game Boy - Pan Docs](https://gbdev.io/pandocs) -* [GameBoy Emulation in JavaScript](http://imrannazar.com/GameBoy-Emulation-in-JavaScript:-The-CPU) -* [POKEGB: a gameboy emulator that only plays Pokémon blue](https://binji.github.io/posts/pokegb) -* [Game Boy CPU Opcodes](https://izik1.github.io/gbops) -* [Codeslinger - Game Boy](http://www.codeslinger.co.uk/pages/projects/gameboy.html) -* [Game Boy hardware database](https://gbhwdb.gekkio.fi) - -### ROMs - -* [GitHub - c-sp/gameboy-test-roms](https://github.com/c-sp/gameboy-test-roms) - -### Emulators - -* [GitHub - LIJI32/SameBoy (C)](https://github.com/LIJI32/SameBoy) -* [GitHub - binji/binjgb (C)](https://github.com/binji/binjgb) -* [GitHub - Rodrigodd/gameroy (Rust)](https://github.com/Rodrigodd/gameroy) -* [GitHub - simias/gb-rs (Rust)](https://github.com/simias/gb-rs) -* [GitHub - RubenG123/frosty (Rust)](https://github.com/RubenG123/frosty) -* [GitHub - feo-boy/feo-boy (Rust)](https://github.com/feo-boy/feo-boy) -* [GitHub - calvinbaart/gameboy (TypeScript)](https://github.com/calvinbaart/gameboy) - -### Videos - -* [YouTube - The Ultimate Game Boy Talk (33c3)](https://www.youtube.com/watch?v=HyzD8pNlpwI) - -### Other - -* [GitHub - gbdev/awesome-gbdev](https://github.com/gbdev/awesome-gbdev) -* [GitHub - Hacktix/Bootix](https://github.com/Hacktix/Bootix) +To get some information about the resources that inspired my through the emulation creation journey check [inspiration.md](doc/inspiration.md). ## License -Boyacian is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/). +Boytacian is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/). diff --git a/doc/inspiration.md b/doc/inspiration.md new file mode 100644 index 00000000..e69de29b -- GitLab