mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 10:12:06 +00:00
Miscellaneous refactoring of code and docs (#1411)
This commit is contained in:
20
README.md
20
README.md
@@ -3,10 +3,10 @@
|
|||||||
RGBDS (Rednex Game Boy Development System) is a free assembler/linker package
|
RGBDS (Rednex Game Boy Development System) is a free assembler/linker package
|
||||||
for the Game Boy and Game Boy Color. It consists of:
|
for the Game Boy and Game Boy Color. It consists of:
|
||||||
|
|
||||||
- rgbasm (assembler)
|
- RGBASM (assembler)
|
||||||
- rgblink (linker)
|
- RGBLINK (linker)
|
||||||
- rgbfix (checksum/header fixer)
|
- RGBFIX (checksum/header fixer)
|
||||||
- rgbgfx (PNG‐to‐Game Boy graphics converter)
|
- RGBGFX (PNG‐to‐Game Boy graphics converter)
|
||||||
|
|
||||||
This is a fork of the original RGBDS which aims to make the programs more like
|
This is a fork of the original RGBDS which aims to make the programs more like
|
||||||
other UNIX tools.
|
other UNIX tools.
|
||||||
@@ -16,11 +16,11 @@ This toolchain is maintained [on GitHub](https://github.com/gbdev/rgbds).
|
|||||||
|
|
||||||
The documentation of this toolchain can be [viewed online](https://rgbds.gbdev.io/docs/).
|
The documentation of this toolchain can be [viewed online](https://rgbds.gbdev.io/docs/).
|
||||||
It is generated from the man pages found in this repository.
|
It is generated from the man pages found in this repository.
|
||||||
The source code of the website itself is on GitHub as well under the repo
|
The source code of the website itself is on GitHub as well under the repository
|
||||||
[rgbds-www](https://github.com/gbdev/rgbds-www).
|
[rgbds-www](https://github.com/gbdev/rgbds-www).
|
||||||
|
|
||||||
If you want to contribute or maintain RGBDS, and have questions regarding the code, its
|
If you want to contribute or maintain RGBDS, or you have questions regarding the code, its
|
||||||
organisation, etc. you can find the maintainers [on the gbdev community channels](https://gbdev.io/chat)
|
organization, etc. you can find the maintainers [on the gbdev community channels](https://gbdev.io/chat)
|
||||||
or via mail at `rgbds at gbdev dot io`.
|
or via mail at `rgbds at gbdev dot io`.
|
||||||
|
|
||||||
## 1. Installing RGBDS
|
## 1. Installing RGBDS
|
||||||
@@ -96,7 +96,7 @@ The RGBDS source code file structure is as follows:
|
|||||||
- `man/` - manual pages.
|
- `man/` - manual pages.
|
||||||
- `src/` - source code of RGBDS.
|
- `src/` - source code of RGBDS.
|
||||||
* Note that the code unique to each RGBDS tool is stored in its respective subdirectory
|
* Note that the code unique to each RGBDS tool is stored in its respective subdirectory
|
||||||
(rgbasm's code is in `src/asm/`, for example). `src/extern/` contains code imported from
|
(RGBASM's code is in `src/asm/`, for example). `src/extern/` contains code imported from
|
||||||
external sources.
|
external sources.
|
||||||
- `test/` - testing framework used to verify that changes to the code don't break or
|
- `test/` - testing framework used to verify that changes to the code don't break or
|
||||||
modify the behavior of RGBDS.
|
modify the behavior of RGBDS.
|
||||||
@@ -121,9 +121,9 @@ The RGBDS source code file structure is as follows:
|
|||||||
this version as [rgbds-linux](https://github.com/vegard/rgbds-linux).
|
this version as [rgbds-linux](https://github.com/vegard/rgbds-linux).
|
||||||
- 2010-01-12: Anthony J. Bentley [forks](https://github.com/bentley) Nossum's
|
- 2010-01-12: Anthony J. Bentley [forks](https://github.com/bentley) Nossum's
|
||||||
repository. The fork becomes the reference implementation of RGBDS.
|
repository. The fork becomes the reference implementation of RGBDS.
|
||||||
- 2015-01-18: stag019 begins implementing [rgbgfx](https://github.com/stag019/rgbgfx),
|
- 2015-01-18: stag019 begins implementing [RGBGFX](https://github.com/stag019/rgbgfx),
|
||||||
a PNG‐to‐Game Boy graphics converter, for eventual integration into RGBDS.
|
a PNG‐to‐Game Boy graphics converter, for eventual integration into RGBDS.
|
||||||
- 2016-09-05: rgbgfx is [integrated](https://github.com/gbdev/rgbds/commit/c3c31138ddbd8680d4e67957e387f2816798a71b)
|
- 2016-09-05: RGBGFX is [integrated](https://github.com/gbdev/rgbds/commit/c3c31138ddbd8680d4e67957e387f2816798a71b)
|
||||||
into Bentley's repository.
|
into Bentley's repository.
|
||||||
- 2017-02-23: Bentley's repository is moved to the [rednex](https://github.com/rednex)
|
- 2017-02-23: Bentley's repository is moved to the [rednex](https://github.com/rednex)
|
||||||
organization.
|
organization.
|
||||||
|
|||||||
@@ -53,9 +53,9 @@ The fork becomes the reference implementation of RGBDS.
|
|||||||
.It
|
.It
|
||||||
2015-01-18:
|
2015-01-18:
|
||||||
.An stag019
|
.An stag019
|
||||||
begins implementing rgbgfx, a PNG‐to‐Game Boy graphics converter, for eventual integration into RGBDS.
|
begins implementing RGBGFX, a PNG‐to‐Game Boy graphics converter, for eventual integration into RGBDS.
|
||||||
.It
|
.It
|
||||||
2016-09-05: rgbgfx is integrated into Bentley's repository.
|
2016-09-05: RGBGFX is integrated into Bentley's repository.
|
||||||
.It
|
.It
|
||||||
2017-02-23: Bentley's repository is moved to the
|
2017-02-23: Bentley's repository is moved to the
|
||||||
.Lk https://github.com/rednex/rgbds rednex
|
.Lk https://github.com/rednex/rgbds rednex
|
||||||
|
|||||||
@@ -566,7 +566,7 @@ void lexer_CheckRecursionDepth() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
static bool isMacroChar(char c) {
|
static bool isMacroChar(char c) {
|
||||||
return c == '@' || c == '#' || c == '<' || (c > '0' && c <= '9');
|
return c == '@' || c == '#' || c == '<' || (c >= '1' && c <= '9');
|
||||||
}
|
}
|
||||||
|
|
||||||
// forward declarations for readBracketedMacroArgNum
|
// forward declarations for readBracketedMacroArgNum
|
||||||
@@ -670,7 +670,7 @@ static std::shared_ptr<std::string> readMacroArg(char name) {
|
|||||||
error("Invalid macro argument '\\0'\n");
|
error("Invalid macro argument '\\0'\n");
|
||||||
return nullptr;
|
return nullptr;
|
||||||
} else {
|
} else {
|
||||||
assume(name > '0' && name <= '9');
|
assume(name >= '1' && name <= '9');
|
||||||
|
|
||||||
MacroArgs *macroArgs = fstk_GetCurrentMacroArgs();
|
MacroArgs *macroArgs = fstk_GetCurrentMacroArgs();
|
||||||
if (!macroArgs) {
|
if (!macroArgs) {
|
||||||
|
|||||||
@@ -174,12 +174,12 @@ int main(int argc, char *argv[]) {
|
|||||||
case 'M':
|
case 'M':
|
||||||
if (dependFile)
|
if (dependFile)
|
||||||
warnx("Overriding dependfile %s", dependFileName);
|
warnx("Overriding dependfile %s", dependFileName);
|
||||||
if (!strcmp("-", musl_optarg)) {
|
if (strcmp("-", musl_optarg)) {
|
||||||
dependFile = stdout;
|
|
||||||
dependFileName = "<stdout>";
|
|
||||||
} else {
|
|
||||||
dependFile = fopen(musl_optarg, "w");
|
dependFile = fopen(musl_optarg, "w");
|
||||||
dependFileName = musl_optarg;
|
dependFileName = musl_optarg;
|
||||||
|
} else {
|
||||||
|
dependFile = stdout;
|
||||||
|
dependFileName = "<stdout>";
|
||||||
}
|
}
|
||||||
if (dependFile == nullptr)
|
if (dependFile == nullptr)
|
||||||
err("Failed to open dependfile \"%s\"", dependFileName);
|
err("Failed to open dependfile \"%s\"", dependFileName);
|
||||||
|
|||||||
Reference in New Issue
Block a user