docs: update for current repo

Former-commit-id: 9f494d57299faa5d1d5a962d617fb047634cd93d Former-commit-id: 262ee4fd58084dce3302539eeb80c116cca9a9a5
2024-03-22 20:56:40 +00:00 · 2024-03-22 20:56:40 +00:00 · 9f5d376e4a
parent f8ce59e129
commit 9f5d376e4a
1 changed files with 4 additions and 80 deletions
--- a/README.md
+++ b/README.md
@ -1,19 +1,12 @@
-# RustBoyAdvance-NG
+# rustboyadvance-ng

-![license](https://img.shields.io/github/license/michelhe/rustboyadvance-ng) ![Build](https://github.com/michelhe/rustboyadvance-ng/workflows/Build/badge.svg?branch=master) 
+Nintendo GameBoy Advance™ emulator and debugger, written in Rust.

-Nintendo GameBoy Advance ™ emulator and debugger, written in rust.
-
-
-<div align="center">
-<img width="360px" src="assets/icon_cropped_small.png">
-</div>
-
-WebAssembly Demo: https://michelhe.github.io/rustboyadvance-ng/ ![Deploy](https://github.com/michelhe/rustboyadvance-ng/workflows/Deploy/badge.svg?branch=master)
+> This repository is a fork of [rustboyadvance-ng](https://github.com/michelhe/rustboyadvance-ng), with minimal non-feature changes.

 # Project Structure
 * `core/` - Main emulator crate that ties everything together 
-* `arm7tdmi/` - Emulation of the Arm7tdmi processor.
+* `arm7tdmi/` - Emulation of the Arm7tdmi processor
 * `platform/` - Constains executables & application built with `rustboyadvance-core`
    * `platform/rustbodyadvance-wasm` - Web emulator powered by WebAssembly
    * `platform/rustbodyadvance-sdl2` - Desktop application built with sdl2
@ -21,47 +14,7 @@ WebAssembly Demo: https://michelhe.github.io/rustboyadvance-ng/ ![Deploy](https:
    * `platform/rustbodyadvance-jni` - Java JNI binidngs for the emulator.
    * `platform/android` - A PoC Android application.

-# Progress
-
-![Pokemon Emerald](media/screenshot1.png)
-
-## Emulation Todo:
-* CGB audio (4 wave generator channels)
-
-# Build and usage (Desktop Application)
-
-To get started, you need to get a [stable rust toolchain](https://rustup.rs) of version Rust 1.51 or later,
-
-## Linux build dependencies
-Install SDL2 dependencies
-
-```bash
-sudo apt-get -y install libsdl2-dev libsdl2-image-dev
-```
-
-## Windows build dependencies
-SDL2 runtime binaries are included in this repository, no extra setup needed.
-
-## Build & Usage
-You need to obtain a gba bios binary.
-An [open source GBA bios](https://github.com/Nebuleon/ReGBA/blob/master/bios/gba_bios.bin) is also available and supported.
-
-
-Place the bios file in the repository root and name it `gba_bios.bin` (or alternatively use the `-b` command line option)
-
-
-Build and run in release mode (performance is terrible in the `dev` profile)
-```bash
-$ cargo run --release -- path/to/rom
-```
-
-
-You can also drag&drop rom files or any zip files containing `.gba` files inside into the emulator window and a new rom will be loaded.
-
 ## Key bindings
-
-> Currently the key bindings are not configureable.
-
 GBA key bindings:

 | Keyboard  	| GBA      	|
@ -85,32 +38,3 @@ Special key bindings
 | F2		| Spawn gdbserver (experimetnal, requires --features gdb) |
 | F5           	| Save snapshot file 	|
 | F9           	| Load snapshot file 	|
-
-
-# Android Application
-
-The android project is placed inside `platform/android`.
-To build it, open it with Android Studio.
-
-You also need to set up rust to build android targets with NDK.
-
-TODO - instructions
-
-# More Screenshots
- ![Kirby - Nightmare in Dreamland](media/screenshot2.png) ![Dragon Ball - Legacy of Goku 2](media/screenshot3.png)
-
-# Links and attribution
-
- [ARM7TDMI Technical Reference Manual](http://infocenter.arm.com/help/topic/com.arm.doc.ddi0210c/DDI0210B.pdf)
-    Technical Reference Manuals are **fun**.
- [GBATEK](http://problemkaputt.de/gbatek.htm)
-    A single webpage written by *no$gba* developer Martin Korth.
-    This page has pretty much everything. Seriously, it's the best.
- [TONC](https://www.coranac.com/tonc/text/)
-    A comprehensive GBA dev guide that I used a-lot in order to understand the GBA system.
-    Comes with neat demo roms that really helped me during development and debugging.
- [NanoboyAdvance](https://github.com/fleroviux/NanoboyAdvance)
-    A GameBoy Advance emulator written in C++17 by a nice person called fleroviux.
-    I've used this for debugging.
- [Eggvance gba-suite](https://github.com/jsmolka/gba-suite)
-    Incredible test suite for the arm7tdmi interpreter that I'm using, written by Julian Smolka.