diff options
| author | Miquel Sabaté Solà <mssola@mssola.com> | 2026-04-25 23:11:42 +0200 |
|---|---|---|
| committer | Miquel Sabaté Solà <mssola@mssola.com> | 2026-04-25 23:11:42 +0200 |
| commit | 98c8f0561d65f81b269400a35a99b64800207486 (patch) | |
| tree | 3dd93267b9c2d69e72e46e44d90b52faa75d0178 | |
| parent | b71bfe075ea2219ba2a29c16a9788a894940532e (diff) | |
| download | tools.nes-98c8f0561d65f81b269400a35a99b64800207486.tar.gz tools.nes-98c8f0561d65f81b269400a35a99b64800207486.zip | |
nasm: add a description on the README.md file
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
| -rw-r--r-- | crates/nasm/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/crates/nasm/README.md b/crates/nasm/README.md index de388f7..204b156 100644 --- a/crates/nasm/README.md +++ b/crates/nasm/README.md @@ -1,3 +1,17 @@ +`nasm` is an assembler specifically tailored for the Famicom/NES. Because of +this, it does not try to replace other assemblers available out there which +cover all 6502 platforms and derivatives. The only goal is to have an assembler +that is suitable for NES/Famicom development. + +As such, only features available for this platform have been implemented. All in +all, `nasm` is an assembler that makes a lot of assumptions on the target +platform, its memory layout, and how developers have to write their code. You +can read more about this down below. + +Last but not least, `nasm` makes an effort at being flexible and as informative +to programmers as possible. Hence, error messages try to be concise, clear, and +pointing exactly where each error happened. + ## Usage The most basic way to use this assembler is by running: |