From f8c8f37e9e8400bc53224960671c71b213f92ce1 Mon Sep 17 00:00:00 2001 From: RochesterX Date: Sat, 21 Feb 2026 19:34:17 -0500 Subject: [PATCH] Update README --- Makefile | 4 ++++ README.md | 7 +++++++ 2 files changed, 11 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d89472d --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +build: + ca65 plat.s -o plat.o + ld65 plat.o -C plat.cfg -o plat.nes + diff --git a/README.md b/README.md index ccce4f8..ea894de 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,13 @@ This is a place where I mess around with developing for the Nintendo Entertainme My main source of documentation is the [NESDev wiki](https://www.nesdev.org/wiki/Nesdev_Wiki), and the project structure is a heavily modified version of [this NES project template](https://github.com/bbbradsmith/NES-ca65-example/tree/master). +## Build Instructions +Building is supported on macOS and Linux. It requires the CC65 toolchain to be installed via your package manager of choice. For macOS: +```macOS +brew install cc65 +``` +Once installed, run ``make build`` to generate the ``plat.nes`` file, which can then be run in any emulator or on original NES hardware with an Everdrive or similar. + ## Features > [!NOTE] > This project is under active development, and the implemented features are rapidly changing. It has no real goal yet, but may end up being a port of my game [Reboot](https://rochesterx.itch.io/reboot).