Skip to content

Commit

Permalink
Misc improvements and rewordings in the first pages
Browse files Browse the repository at this point in the history
  • Loading branch information
avivace committed Dec 20, 2024
1 parent 38a8c5b commit 8b753fa
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 22 deletions.
8 changes: 7 additions & 1 deletion src/help-feedback.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Help

We hope this tutorial will work for you.

But if it doesn't (the format may not work well for everyone, and that's okay), we encourage to look at [some other resources](resources.md), which might work better for you.

It's also fine to **take a break from time to time**; feel free to read at your own pace.

If you are stuck in a certain part of the tutorial, want some advice, or just wish to chat with us, [the GBDev community chat](https://gbdev.io/chat) is the place to go!
The authors actively participate there so don't be afraid to ask questions!
(The "ASM" channel should be the most appropriate to discuss the tutorial, by the way.)
The `#asm` channel should be the most appropriate to discuss the tutorial.

If you prefer email, you can reach us at `tutorial@<domain>`, where you replace `<domain>` with this website's domain name.
Anti-spam measure, I hope you understand.
6 changes: 3 additions & 3 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
👋 Welcome to gb-asm-tutorial!
This tutorial will teach you how to make games for the Game Boy and Game Boy Color.

:::warning:⚠️
:::tip

While the Game Boy and Game Boy Color are almost the same console, **the Game Boy Advance is entirely different**.
However, the GBA is able to run GB and GBC games!
If you are looking to program GBC games and run them on a GBA, you're at the right place; however, if you want to make games specifically for the GBA, please check out the [Tonc](https://gbadev.net/tonc/) tutorial instead.
If you are looking to program GBC games and run them on a GBA, you're at the right place; however, if you want to make games specifically for the GBA, please check out the [Tonc tutorial](https://gbadev.net/tonc/) instead.

:::

Expand Down Expand Up @@ -44,7 +44,7 @@ You can also help **translating** the tutorial on [Crowdin](https://crowdin.com/
**In short**:

- Code within the tutorial is essentially **public domain**, meaning that you are allowed to copy it freely without restrictions.
- You are free to copy the tutorial's contents (prose, diagrams, etc.), modify them, and share that, but you must give credit and license any copies permissively.
- You are free to copy the tutorial's contents (prose, diagrams, etc.), modify them, and share that, but you must give credit and license any copies under the same license.
- This site's _source code_ can be freely copied, but you must give a license and copyright notice.

**Full details**, please follow these links for more information on the respective licenses:
Expand Down
6 changes: 3 additions & 3 deletions src/part1/bin_and_hex.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Here's how digits work:
And here we can see the digits that make up the number!
```

:::tip:ℹ️
:::tip CONVENTION

`^` here means "to the power of", where `X^N` is equal to multiplying `X` with itself `N` times, and `X ^ 0 = 1`.

Expand Down Expand Up @@ -102,9 +102,9 @@ And, don't worry, decimal can still be used 😜

(Side note: one could point that octal, i.e. base 8, would also work for this; however, we will primarily deal with units of 8 bits, for which hexadecimal works much better than octal. RGBDS supports octal via the `&` prefix, but I have yet to see it used.)

:::tip:💡
:::tip

If you're having trouble converting between decimal and binary/hexadecimal, check if your favorite calculator program doesn't have a "programmer" mode, or a way to convert between bases.
If youre having trouble converting between decimal and binary/hexadecimal, check whether your favorite calculator program has a 'programmer' mode or a way to convert between bases.

:::

Expand Down
4 changes: 2 additions & 2 deletions src/part1/hello_world.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Grab the following files (right-click each link, "Save Link As..."), and place t

Then, still from a terminal within that directory, run the following three commands.

:::warning:⚠️
:::tip CONVENTION

To clarify where each individual command begins, I've added a `$` before each command, but don't type them!
To make it clear where each command begins, they are preceded by a `$` symbol. However, do not type it when entering them in your shell!

:::

Expand Down
2 changes: 1 addition & 1 deletion src/part1/registers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Alright!
Now that we know what bits are, let's talk about how they're used.
Don't worry, this is mostly prep work for the next section, where we will—finally!—look at the code 👀
Don't worry, this is mostly preliminary work for the next section, where we will—finally!—look at the code 👀

First, if you opened Emulicious, you have been greeted with just the Game Boy screen.
So, it's time we pop the debugger open!
Expand Down
12 changes: 0 additions & 12 deletions src/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,4 @@ Along the way, we will make plenty of mistakes, so we can learn how to debug our

And finally, Part Ⅲ is about "advanced" use of the hardware, where we learn how to make even better-looking games, and we program a Shoot 'Em Up!

:::tip

We hope this tutorial will work for you.

But if it doesn't (the format may not work well for everyone, and that's okay), I encourage you to look at [some other resources](resources.md), which might work better for you.

It's also fine to **take a break from time to time**; feel free to read at your own pace, and to [ask for clarifications](https://gbdev.io/chat) if anything isn't clear to you.

:::

---

This tutorial is a work in progress.

0 comments on commit 8b753fa

Please sign in to comment.