aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mssola@mssola.com>2026-07-15 22:11:50 +0200
committerMiquel Sabaté Solà <mssola@mssola.com>2026-07-15 22:11:50 +0200
commit9d790bb4acddae689c5dda667f9d160041bdd4b8 (patch)
tree2d719d596a21e63bfe465e2c72f9caababec70c7 /README.md
parent61b9ce33d54bc643b0ece227101d8bf571fd86e5 (diff)
downloadtools.nes-9d790bb4acddae689c5dda667f9d160041bdd4b8.tar.gz
tools.nes-9d790bb4acddae689c5dda667f9d160041bdd4b8.zip
readrom: implement the -d/--disassemble option
This option can also be coupled with -n/--nasm-directory, and you can then get a human-readable disassembling of any proc or label you might be thinking on. Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/README.md b/README.md
index 771f9a5..80f171d 100644
--- a/README.md
+++ b/README.md
@@ -22,10 +22,9 @@ will invoke `nasm` with more pedantic features like its address sanitizer.
## `readrom`
-The `readrom` program reads a given ROM file and shows all the information that
-can be gathered from it. For now this only applies to information on the header,
-but in the future we might want to add disassembling user-specified segments,
-for example.
+`readrom` is an objdump-like utility that reads a given ROM file and shows
+information about it. Read more about it in
+[./crates/readrom/README.md](./crates/readrom/README.md).
## License