Reorganize the readme

- Use sub-headings to let the reader skim more easily
- Link specifically to the Discord server before less-useful
  "other community channels"
This commit is contained in:
Rangi
2026-07-14 10:34:43 -04:00
committed by Rangi
parent cb34fe18f7
commit a821badc3e
+30 -24
View File
@@ -1,33 +1,39 @@
# RGBDS # RGBDS
RGBDS (Rednex Game Boy Development System) is a free assembler/linker package [RGBDS](https://github.com/gbdev/rgbds) (Rednex Game Boy Development System) is
for the Game Boy and Game Boy Color. It consists of: a free assembler/linker package for the Game Boy and Game Boy Color.
- RGBASM (assembler) It consists of four tools:
- RGBLINK (linker)
- RGBFIX (checksum/header fixer)
- RGBGFX (PNG-to-Game Boy graphics converter)
This is a fork of the original RGBDS which aims to make the programs more like - **RGBASM:** assembler
other UNIX tools. - **RGBLINK:** linker
- **RGBFIX:** ROM checksum/header fixer
- **RGBGFX:** PNG-to-Game Boy graphics converter
This toolchain is maintained [on GitHub](https://github.com/gbdev/rgbds). ## Documentation
The documentation of this toolchain can be [viewed online](https://rgbds.gbdev.io/docs/), The [full documentation](https://rgbds.gbdev.io/docs/) is available online,
including its [basic usage and development history](https://rgbds.gbdev.io/docs/rgbds.7). including the [development history](https://rgbds.gbdev.io/docs/rgbds.7) and
It is generated from the man pages found in this repository. [version history](https://rgbds.gbdev.io/versions), generated from the man pages
The source code of the website itself is on GitHub as well under the repository in this repository.
[rgbds-www](https://github.com/gbdev/rgbds-www).
If you want to contribute or maintain RGBDS, please read [our contribution guide](/docs/CONTRIBUTING.md). The documentation website's own source code is available in the
If you have questions regarding the code, its organization, etc. you can find the maintainers [rgbds-www](https://github.com/gbdev/rgbds-www) repository.
[on the GBDev community channels](https://gbdev.io/chat) or via mail at `rgbds at gbdev dot io`.
## Installing RGBDS ## Community
The [installation procedure](https://rgbds.gbdev.io/install) is available If you have questions about the RGBDS code or its organization, you can contact
online for various platforms. [Building from source](https://rgbds.gbdev.io/install/source) the maintainers on the [GBDev Discord server](https://discord.gg/RjJKA8wrD4) or
is possible using `make` or `cmake`; follow the link for more detailed instructions. [other community channels](https://gbdev.io/chat), or via email at
`rgbds at gbdev dot io`.
If you want to help maintain RGBDS, please read [the contribution guide](/docs/CONTRIBUTING.md).
## Installing
The [platform-specific installation instructions](https://rgbds.gbdev.io/install/)
are available online. To [build from source](https://rgbds.gbdev.io/install/source)
using `make` or `cmake`, briefly:
```sh ```sh
make make
@@ -40,8 +46,8 @@ cmake --build build
cmake --install build cmake --install build
``` ```
Two parameters available when building are a prefix (e.g. to put the executables in a directory) Both build systems support a prefix (e.g. to install into a specific directory)
and a suffix (e.g. to append the version number or commit ID). and a suffix (e.g. to append the version number or commit ID):
```sh ```sh
make make
@@ -54,4 +60,4 @@ cmake --build build
cmake --install build --prefix install_dir cmake --install build --prefix install_dir
``` ```
(If you set a `SUFFIX`, it should include the `.exe` extension on Windows.) On Windows, any `SUFFIX` should include the `.exe` extension.