From 988332816972638adfa8000dd7e1a474c5fea424 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 1 Nov 2023 09:20:03 +0100 Subject: basics: Improve documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add more comments to `sprite.s` and `persist.s` so they can be read by a newcomer, and also introduce a README for this directory. Signed-off-by: Miquel Sabaté Solà --- basics/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 basics/README.md (limited to 'basics/README.md') diff --git a/basics/README.md b/basics/README.md new file mode 100644 index 0000000..7571509 --- /dev/null +++ b/basics/README.md @@ -0,0 +1,15 @@ +## Basics + +Here we have simple programs which try to explain a particular topic of NES +programming. They are single files which already contain all you need in order +to have a working program. This means that there is quite a lot of boilerplate +you might not be aware. For this reason I encourage you to start with the +`sprite.s` file, which has a step by step explanation on how the NES is +initialized and what do all these magic "HEADER" and other jargon actually mean. +Anyhow, these programs are as follows: + +- `sprite.s`: detailed explanation on how to initialize the NES in order to have + some background and a sprite shown on screen. Follow along the code in order + to get a detailed explanation on each section. +- `input.s`: how to read the input from one controller. +- `persist.s`: using the MMC1 chip in order to persist data. -- cgit v1.2.3