summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvin <git@vineetk.net>2024-08-21 13:31:29 -0400
committervin <git@vineetk.net>2024-08-21 13:47:05 -0400
commit97332c8a381eb026c8009a32a75a423e9ba92993 (patch)
tree35cd7dc518b862c1f9d47fc5c3c0e19cfc3984ca
parent362341eac334ada91de79360d98924c48061a657 (diff)
update README
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index c8879a8..1d535ef 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,19 @@
-emu_nes
-=======
+# emu_nes
A Nintendo Entertainment System (NES) emulator written for the purpose of
understanding how the NES and similar 8-bit computers of that era worked.
Makes heavy use of https://www.nesdev.org/.
+
+## Current State
+- [x] CPU (2A03/6502)
+- [ ] PPU (Graphics)
+- [ ] APU (Audio)
+
+Currently, running the emulator with nestest.nes results in incorrect
+results in the memory space of the APU registers. This is due to the
+APU not being implemented yet.
+
+Also, the only ROM mapper that is implemented is Mapper 0 to
+run the test ROM, but it also supports many other ROMs listed
+[here](https://nesdir.github.io/mapper0.html) such as Donkey Kong and
+Super Mario Bros.