From 407048d0037c8d6d26c7e3fe2384e974212f124e Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 18 Dec 2024 07:46:26 +0100 Subject: Add the readrom binary MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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à --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4a74a66..6d99cd4 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3