Skip to content

Commit 8b753fa

Browse files
committed
Misc improvements and rewordings in the first pages
1 parent 38a8c5b commit 8b753fa

File tree

6 files changed

+16
-22
lines changed

6 files changed

+16
-22
lines changed

src/help-feedback.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# Help
22

3+
We hope this tutorial will work for you.
4+
5+
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.
6+
7+
It's also fine to **take a break from time to time**; feel free to read at your own pace.
8+
39
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!
410
The authors actively participate there so don't be afraid to ask questions!
5-
(The "ASM" channel should be the most appropriate to discuss the tutorial, by the way.)
11+
The `#asm` channel should be the most appropriate to discuss the tutorial.
612

713
If you prefer email, you can reach us at `tutorial@<domain>`, where you replace `<domain>` with this website's domain name.
814
Anti-spam measure, I hope you understand.

src/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
👋 Welcome to gb-asm-tutorial!
44
This tutorial will teach you how to make games for the Game Boy and Game Boy Color.
55

6-
:::warning:⚠️
6+
:::tip
77

88
While the Game Boy and Game Boy Color are almost the same console, **the Game Boy Advance is entirely different**.
99
However, the GBA is able to run GB and GBC games!
10-
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.
10+
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.
1111

1212
:::
1313

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

4646
- Code within the tutorial is essentially **public domain**, meaning that you are allowed to copy it freely without restrictions.
47-
- 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.
47+
- 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.
4848
- This site's _source code_ can be freely copied, but you must give a license and copyright notice.
4949

5050
**Full details**, please follow these links for more information on the respective licenses:

src/part1/bin_and_hex.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Here's how digits work:
2121
And here we can see the digits that make up the number!
2222
```
2323

24-
:::tip:ℹ️
24+
:::tip CONVENTION
2525

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

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

103103
(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.)
104104

105-
:::tip:💡
105+
:::tip
106106

107-
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.
107+
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.
108108

109109
:::
110110

src/part1/hello_world.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Grab the following files (right-click each link, "Save Link As..."), and place t
1212

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

15-
:::warning:⚠️
15+
:::tip CONVENTION
1616

17-
To clarify where each individual command begins, I've added a `$` before each command, but don't type them!
17+
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!
1818

1919
:::
2020

src/part1/registers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

77
First, if you opened Emulicious, you have been greeted with just the Game Boy screen.
88
So, it's time we pop the debugger open!

src/roadmap.md

-12
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,4 @@ Along the way, we will make plenty of mistakes, so we can learn how to debug our
1010

1111
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!
1212

13-
:::tip
14-
15-
We hope this tutorial will work for you.
16-
17-
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.
18-
19-
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.
20-
21-
:::
22-
23-
---
24-
2513
This tutorial is a work in progress.

0 commit comments

Comments
 (0)