diff options
| author | Miquel Sabaté Solà <mikisabate@gmail.com> | 2024-12-18 07:46:26 +0100 |
|---|---|---|
| committer | Miquel Sabaté Solà <mikisabate@gmail.com> | 2024-12-18 07:46:26 +0100 |
| commit | 407048d0037c8d6d26c7e3fe2384e974212f124e (patch) | |
| tree | 7f083e85156c61ed0193d6336ae3445bbcb6df74 /README.md | |
| parent | 5cea733924c3fd9df91a19c7d7c59ae85915221b (diff) | |
| download | tools.nes-407048d0037c8d6d26c7e3fe2384e974212f124e.tar.gz tools.nes-407048d0037c8d6d26c7e3fe2384e974212f124e.zip | |
Add the readrom binary
The readrom binary is similar to `readelf` from Linux and it will allow
to display information from an NES/Famicom ROM file. For now the
information being shown is just the header, but in the future we might
also include disassembling parts of the code, or retrieving the "CHARS"
section for a given ROM file, and similar.
In order to implement the header parsing part a new library has been
introduced, simply named "header" which abstracts everything away so you
just need to call `Header::try_from("my bytes")` to fetch the actual
information.
Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -19,3 +19,10 @@ changed with the `-c/--configuration` flag, which accepts the following values: `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). + +## `readrom` + +The `readrom` 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. |
