aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index c3a2a88..5704070 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,19 @@
[Advent of Code 2023](https://adventofcode.com/2023) on the NES, baby! (let's
see if I actually finish it...)
-Each day is written into its own file inside of `src`. Build everything by just
-calling `make` and you will get a `.nes` file per day inside of the `out`
-directory. Before doing that, though, you will need a compiler for the 6052
-platform. A good option is [cc65](https://github.com/cc65/cc65), which is
-available on all major platforms. Otherwise, if you want to use another
-compiler, you can pass the `CC65` and `CCOPTS` variables to the Makefile.
+Each day is written into its own file inside of `src`. In order to clone it bear
+in mind that the `vendor` directory has git submodules. Hence:
+
+``` sh
+git clone --recurse-submodule https://github.com/mssola/aoc2023.nes.git
+```
+
+Build everything by just calling `make` and you will get a `.nes` file per day
+inside of the `out` directory. Before doing that, though, you will need a
+compiler for the 6052 platform. A good option is
+[cc65](https://github.com/cc65/cc65), which is available on all major platforms.
+Otherwise, if you want to use another compiler, you can pass the `CC65` and
+`CCOPTS` variables to the Makefile.
After that, it's recommended that you run the ROMs with an emulator with
debugging support or at least some form of memory visualization. This is because