Files
mynes/README.md
2026-04-05 04:50:31 +02:00

10 lines
919 B
Markdown

# mynes
mynes (pronounced minus) is a NES emulator inspired by the NES test [video.](https://youtu.be/oYjYmSniQyM) by "100th Coin" the goal is to make an emulator which passes all of the test. But which does so 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](https://en.wikipedia.org/wiki/X_Window_System) (for making a window/displaying the screen), [Unity](https://www.throwtheswitch.org/unity) (for testing) and standard C/POSIX libs
- 2 C99 only
- 3 minimal use of abbreviations etc in code + [doxygen](https://github.com/doxygen/doxygen) code comments within .h files.
- 4 using my own custom [shmake]() C build/project management script (this project is also acting as a way for me to dogfood shmake)
- 5 8-space indentation plus other [crisp-style]() C code.