aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJames Barnett <noreply@jamesbarnett.xyz>2018-12-22 14:16:40 +0000
committerGitHub <noreply@github.com>2018-12-22 14:16:40 +0000
commitfcedb2bcdd98d71e0e3a6c1fec3525be413578eb (patch)
treeb1a7e25897a4160a09044a0eb2d4f9abcd81e5d6 /README.md
parent7b83b892bec7b540d4d8bac132084a2f5db6c195 (diff)
downloadKGB-fcedb2bcdd98d71e0e3a6c1fec3525be413578eb.tar.xz
KGB-fcedb2bcdd98d71e0e3a6c1fec3525be413578eb.zip
Update README.mdHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 29 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1646a6d..9adfd86 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
-# KotlinGameBoy
-A Game Boy emulator (eventually...) written in Kotlin \ No newline at end of file
+# KGB - Kotlin Game Boy
+A Game Boy emulator (eventually...) written in Kotlin
+<p align="center">
+ <img alt="Screenshot" src="https://jamesbarnett.io/files/kgb/kgb-1.png">
+</p>
+
+# Features
+- Steppable CPU execution
+- CPU register + flag inspector
+- Ram dump
+
+# Implementation Status
+All non interrupt related opcodes implemented.
+Simple GPU generating test pattern.
+- [ ] CPU
+ - [X] Registers
+ - [X] Flags
+ - [X] Opcodes
+ - [ ] Interrupts
+ - [ ] Timers
+- [ ] GPU
+ - [ ] Pixel pipeline
+ - [ ] Sprites
+- [ ] MMU
+ - [ ] DMA
+ - [ ] Bank switching
+- [ ] I/O
+ - [ ] Controller inputs
+ - [ ] Sound