add some gifs/pictures to the readme

This commit is contained in:
Matthew Berry 2020-11-16 22:32:57 -08:00
parent 3b7e0448c9
commit b5ba760993
5 changed files with 32 additions and 1 deletions

View file

@ -2,13 +2,44 @@
A very rough start to a Game Boy Advance emulator in Crystal Lang. The long-term goal is simply playability of popular titles. The name of the project come from the emudev discord, where "crab" was suggested for "Crystal Advanced Boy." Close enough.
![](README/aw.gif)
![](README/brin.gif)
![](README/swi_demo.png)
![](README/m3_demo.png)
## Installation
At the moment, a `shards install` is all that's required.
## Usage
This is not in a functional state. As arm instructions are being implemented, you can print the trace by compiling with `-Dtrace` or print logs by compiling with `-Dlog`. Next, simply provide the executable with the path to your rom.
This is not in a functional state. As instructions are being implemented, you can print the trace by compiling with `-Dtrace` or print logs by compiling with `-Dlog`. Next, simply provide the executable with the path to your rom.
## Features and Remaining Work
### Features
- GLSL shaders for color reproduction
- Basic PPU mode 0, 3, 4, and 5 implementations
- Passing [armwrestler](https://github.com/destoer/armwrestler-gba-fixed)
- Passing [FuzzARM](https://github.com/DenSinH/FuzzARM)
- Passing roughly half of [gba-suite](https://github.com/jsmolka/gba-suite)
### Remaining Work
Really, this list should include _everything_...
- Interrupts
- Timers
- Sound
- PPU things
- Affine
- Mosaic
- Window
- Objects
- Alpha blending
- Etc
- Etc
## Contributing

BIN
README/aw.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 780 KiB

BIN
README/brin.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 MiB

BIN
README/m3_demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
README/swi_demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB