From 5cea733924c3fd9df91a19c7d7c59ae85915221b Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Mon, 16 Dec 2024 16:29:49 +0100 Subject: Update the README for open sourcing the project MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 91d2ed7..4a74a66 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -Under development +Utilities for NES/Famicom development. Note that this repository is under heavy +development and it's **not** currently usable. + +## `nasm` + +`nasm` is an assembler specifically tailored for the NES/Famicom. You can simply +run it like so: + +``` +$ cargo run --bin nasm +``` + +By default it will assume the configuration for an `NROM` file, but this can be +changed with the `-c/--configuration` flag, which accepts the following values: + +- `empty`: just `HEADER` and `CODE`. Useful for one-liners (e.g. "how is this + instruction encoded in binary?"). +- `nrom`: the default configuration. It has the following segments: `HEADER`, + `CODE`, `VECTORS`, and `CHARS`. +- `nrom65`: same as `nrom` but it also has `STARTUP` for compatibility with the + default linker configuration from [cc65](https://github.com/cc65/cc65). -- cgit v1.2.3