diff --git a/README.md b/README.md index 18d0175..a3318ff 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,18 @@ Just another implementation of a NES emulator written in Rust. -This is an exploratory coding project with the aim to understand concepts of assembler emulation. If you are looking for a cycle-accurate ready-to-use NES emulator, you should probably not use this one. +**A note of warning:** This is an exploratory coding project with the aim to understand concepts of assembler and emulation in general. If you are looking for a cycle-accurate ready-to-use NES emulator to play some games, this is the wrong one. + +## what works +* CPU +* Reading Roms (iNES) +* Memory mapping and RAM +* A very simplistic debugger + +## what does not work +* GPU / graphics +* APU / sound +* Controllers +* a lot of mappers +* game saves +* everything else