diff options
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | README.md | 19 | ||||
| -rw-r--r-- | tests/src/chr-ram.s | 4 | ||||
| -rw-r--r-- | tests/src/sprite.s | 4 |
4 files changed, 15 insertions, 14 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd58352..3076408 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ desired binaries/tests. ## Issue reporting I'm using Github in order to host the code. Thus, in order to report issues you -can do it on its [issue tracker](https://github.com/mssola/ntools/issues). A +can do it on its [issue tracker](https://github.com/mssola/tools.nes/issues). A couple of notes on reports: - Check that the issue has not already been reported or fixed in the `main` @@ -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 diff --git a/tests/src/chr-ram.s b/tests/src/chr-ram.s index 828217f..401588d 100644 --- a/tests/src/chr-ram.s +++ b/tests/src/chr-ram.s @@ -1,5 +1,5 @@ -;;; From https://github.com/mssola/NES which will be open sourced soon (pinky -;;; promess!). +;;; From https://github.com/mssola/code.nes which will be open sourced soon +;;; (pinky promess!). .segment "HEADER" .byte 'N', 'E', 'S', $1A diff --git a/tests/src/sprite.s b/tests/src/sprite.s index 84eaaa0..d57426d 100644 --- a/tests/src/sprite.s +++ b/tests/src/sprite.s @@ -1,5 +1,5 @@ -;;; NOTE: taken from https://github.com/mssola/NES; which I will open source -;;; sooner rather than later. +;;; NOTE: taken from https://github.com/mssola/code.nes; which I will open +;;; source sooner rather than later. ;;; ;; Show a sprite to the screen! This example also contains fully detailed ;; explanations on each section on how an NES game is initialized and stored. |