From f0a4d35599ef2ea926bf04cca9707153dc432736 Mon Sep 17 00:00:00 2001 From: Moon Date: Sun, 16 Jun 2024 06:44:03 -0400 Subject: [PATCH] change README --- README.md | 48 ++---------------------------------------------- 1 file changed, 2 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index a06f322..781f535 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,6 @@ -# **NES Boilerplate Game** +# **NES MM5 Demo Game** -A NES game that serves as a base for starting a new NES project. - ------------------ - -- [**Features**](#features) -- [**Prerequisite**](#prerequisite) -- [**Project configuration**](#project-configuration) - - [**Source configuration**](#source-configuration) - - [**Makefile configuration**](#makefile-configuration) - - [**FamiStudio configuration**](#famistudio-configuration) -- [**Building the game**](#building-the-game) -- [**Running the game**](#running-the-game) - ------------------ - -## **Features** - -This project has/can: - -- Compile the game from assembly code. -- Compile the game from c code. -- A reset handler that reset memory to 0 and call the main function. -- A general NMI handler to draw stuff on the screen. -- An IRQ handler (that does nothing, but we need one). -- Support for the FamiStudio Sound Engine () -- Some defined constant (PPU, APU, etc.). -- Compile the game with the MMC5 mapper. () - -Note: *This project has by default 32K of PRG and 8K of CHR.* - ------------------ +A NES game that does the minimum to bootstrap MM5. ## **Prerequisite** @@ -39,26 +9,12 @@ Note: *This project has by default 32K of PRG and 8K of CHR.* You will need to have CC65 and the files that comes with it. It can be downloaded here: -### **Emulator** - -You theoretically don't need a NES emulator, -but unless your developing on hardware without testing on software (why ?), -I recommend the Mesen emulator because of these debugging features: - ### **Other (Optional)** #### **NesDev Wiki** In case you don't know this website exist, it is **THE most useful** website about how to program on the NES and many other things: -#### **Text Editor** - -Choose any software you want to write your code, I personally like VS Code because of the syntax highlight and error checking, but use what you are comfortable with. - -#### **Hexdump** - -You can download "Hexdump for Windows" if you need to output files in hexadecimal: - #### **YY-CHR** YY-CHR is an editor that you can use to edit the background and sprites in your CHR of your game: