From 357baf81b6ccb94724c98d8fe7c2c0e63f3ca5b8 Mon Sep 17 00:00:00 2001 From: epochryphon Date: Sun, 5 Apr 2026 04:41:26 +0200 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26378e9..8c0aef9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ # 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. \ No newline at end of file +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. \ No newline at end of file