diff --git a/README.md b/README.md index d9dcc1b..06807e3 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ 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 +- 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 code comments within .h files. +- 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. \ No newline at end of file