gbdev / gbdev/rgbds

Document RGBLINK's support for SDAS object files

Open
#1,665 14 comments 0 reactions 0 assignees View on GitHub
docs rgblink
Dominant language
C++
Stars
1.6k
Forks
193
Avg merge
22h 17m
Merged PRs (30d)
26

Description

[RGBDS 0.4.1](https://github.com/gbdev/rgbds/releases/tag/v0.4.1) added "GBDK support" (aka RGBLINK support for objects output by SDAS) in July 2020, but we've neglected to document it. Update rgblink.1 to not only mention "RGB objects".

Note that #1008 mentions other bullet points for ostensibly complete "C toolchain" usability. I don't know how essential/blocking any of those are to actually using RGBASM+RGBLINK as part of a C+asm multilanguage project.

Contributor guide

Open the contributing guide

Research direction

Start with rgblink.1 and compare its current wording with the RGBDS 0.4.1 release note about GBDK/SDAS object support. Review #1008 for the other proposed C toolchain points, then update the man page so RGBLINK's SDAS object support is accurately documented; the change is done when the relevant documentation no longer mentions only RGB objects.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.