Update README.md

This commit is contained in:
2026-04-05 04:41:26 +02:00
parent 3821d8470a
commit 357baf81b6

View File

@@ -1,3 +1,10 @@
# mynes # mynes
mynes is a NES emulator inspired by 100th coin NES test [video.](https://youtu.be/oYjYmSniQyM) The goal is to make an emulator which passes all of the test, but in a code base which is very intuitive to understand. As well as minimal (memory wise) and performant. mynes is a NES emulator inspired by 100th coin NES test [video.](https://youtu.be/oYjYmSniQyM) The goal is to make an emulator which passes all of the test, but in a code base which is very intuitive to understand. As well as minimal (memory wise) and performant.
To achieve these goals these are the restraints:
- 1 no external dependancies outside of X11 (for making a window/displaying the screen), Unity (for testing) and standard C/POSIX libs
- 2 C99 only
- 3 minimal use of abbreviations etc in code + doxygen code comments within .h files.
- 4 using my own custom shmake build/project management script (this project is also acting as a way for me to dogbowl shmake)
- 5 8-space indentation plus other [crisp-style]() C code.