aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mikisabate@gmail.com>2024-12-25 22:02:33 +0100
committerMiquel Sabaté Solà <mikisabate@gmail.com>2024-12-25 22:13:13 +0100
commit3c8773bf8ea8a17550f50f17eb211ae1a561bfb6 (patch)
treefa9c4cee48feb2010b08f62445ea13d16805cfab /README.md
parent56683e97bff9f3dff5c10b0c524d650a5f6b11d6 (diff)
downloadtools.nes-3c8773bf8ea8a17550f50f17eb211ae1a561bfb6.tar.gz
tools.nes-3c8773bf8ea8a17550f50f17eb211ae1a561bfb6.zip
Rename to tools.nes
Let's continue with the good ol' tradition of being terrible at naming things. I have also renamed another project which was referenced here, so update all references as well. Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index bbc281e..8b4c08a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
-Utilities for NES/Famicom development. Note that this repository is under heavy
-development and it's **not** currently usable.
+Tools I have created to help with NES/Famicom development.
+
+**Note**: this is under heavy development and it's not currently usable.
## `nasm`
@@ -18,9 +19,9 @@ it like so:
$ nasm -o awesome.nes awesome.s
```
-Last but not least, you can actually tell `nasm` to redirect the output to
-stdout instead with the `--stdout` flag. This is useful when debugging the
-binary format with another CLI tool. For example:
+Moreover, you can actually tell `nasm` to redirect the output to stdout instead
+with the `--stdout` flag. This is useful when debugging the binary format with
+another CLI tool. For example:
```
$ nasm --stdout awesome.s | hexdump -C
@@ -48,10 +49,10 @@ for reference.
## `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.
+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.
## License