Skip to content

Commit

Permalink
Rename to tools.nes
Browse files Browse the repository at this point in the history
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à <[email protected]>
  • Loading branch information
mssola committed Dec 25, 2024
1 parent 56683e9 commit 3c8773b
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 14 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`

Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions tests/src/chr-ram.s
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions tests/src/sprite.s
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 3c8773b

Please sign in to comment.