Skip to content

Commit 39e85c6

Browse files
authored
Document pre-ASMotor history and add links (gbdev#1252)
1 parent aa5b163 commit 39e85c6

File tree

1 file changed

+36
-15
lines changed

1 file changed

+36
-15
lines changed

README.rst

+36-15
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ is possible using ``make`` or ``cmake``; follow the link for more detailed instr
4444
2. RGBDS Folder Organization
4545
----------------------------
4646

47-
The RGBDS source code file structure somewhat resembles the following:
47+
The RGBDS source code file structure is as follows:
4848

4949
::
5050

5151
.
5252
├── .github/
53-
│ ├── actions/
53+
│ ├── scripts/
5454
│ │ └── ...
5555
│ └── workflows/
5656
│ └── ...
@@ -80,6 +80,7 @@ The RGBDS source code file structure somewhat resembles the following:
8080
│ └── run-tests.sh
8181
├── .clang-format
8282
├── CMakeLists.txt
83+
├── Dockerfile
8384
├── Makefile
8485
└── README.rst
8586

@@ -89,7 +90,7 @@ The RGBDS source code file structure somewhat resembles the following:
8990
- ``.github/`` - files and scripts related to the integration of the RGBDS codebase with
9091
GitHub.
9192

92-
* ``actions/`` - scripts used by workflow files.
93+
* ``scripts/`` - scripts used by workflow files.
9394
* ``workflows/`` - CI workflow description files.
9495

9596
- ``contrib/`` - scripts and other resources which may be useful to users and developers of
@@ -116,28 +117,48 @@ The RGBDS source code file structure somewhat resembles the following:
116117

117118
- ``.clang-format`` - code style for automated C++ formatting with |clang-format|_.
118119

120+
- ``Dockerfile`` - defines how to build RGBDS with Docker.
121+
119122
3. History
120123
----------
121124

122-
- 1997-07-03: Carsten Sørensen (a.k.a. SurfSmurf) writes ASMotor as a
123-
general-purpose assembler/linker system for DOS/Win32.
125+
- 1996-10-01: Carsten Sørensen (a.k.a. SurfSmurf) releases
126+
`xAsm <http://otakunozoku.com/RGBDSdocs/asm.htm>`__,
127+
`xLink <http://otakunozoku.com/RGBDSdocs/link.htm>`__, and
128+
`RGBFix <http://otakunozoku.com/RGBDSdocs/fix.htm>`__,
129+
a Game Boy SM83 (GBZ80) assembler/linker system for DOS/Win32.
130+
131+
- 1997-07-03: Sørensen releases `ASMotor <http://otakunozoku.com/RGBDSdocs/geninfo.htm>`__,
132+
packaging the three programs together and moving towards making them a
133+
general-purpose target-independent system.
124134

125-
- 1999-08-01: Justin Lloyd (a.k.a. Otaku no Zoku) adapts ASMotor to read and
126-
produce GBZ80 assembly/machine code, and releases this version as RGBDS.
135+
- 1999-08-01: Justin Lloyd (a.k.a. Otaku no Zoku) adapts ASMotor to re-focus
136+
on SM83 assembly/machine code, and releases this version as
137+
`RGBDS <http://otakunozoku.com/rednex-gameboy-development-system/>`__.
127138

128139
- 2009-06-11: Vegard Nossum adapts the code to be more UNIX-like and releases
129-
this version as rgbds-linux on `GitHub <https://github.com/vegard/rgbds-linux>`__.
140+
this version as `rgbds-linux <https://github.com/vegard/rgbds-linux>`__.
141+
142+
- 2010-01-12: Anthony J. Bentley `forks <https://github.com/bentley>`__ Nossum's
143+
repository. The fork becomes the reference implementation of RGBDS.
144+
145+
- 2015-01-18: stag019 begins implementing `rgbgfx <https://github.com/stag019/rgbgfx>`__,
146+
a PNG‐to‐Game Boy graphics converter, for eventual integration into RGBDS.
147+
148+
- 2016-09-05: rgbgfx is `integrated <https://github.com/gbdev/rgbds/commit/c3c31138ddbd8680d4e67957e387f2816798a71b>`__
149+
into Bentley's repository.
130150

131-
- 2010-01-12: Anthony J. Bentley forks that repository. The fork becomes the reference
132-
implementation of RGBDS.
151+
- 2017-02-23: Bentley's repository is moved to the `rednex <https://github.com/rednex>`__
152+
organization.
133153

134-
- 2017-02-23: Bentley's repository is moved to a neutral name, Rednex.
154+
- 2018-01-26: The codebase is `relicensed <https://github.com/gbdev/rgbds/issues/128>`__
155+
under the MIT license.
135156

136-
- 2018-01-26: The codebase relicensed under the MIT license.
157+
- 2020-09-15: The repository is `moved <https://github.com/gbdev/rgbds/issues/567>`__
158+
to the `gbdev <https://github.com/gbdev>`__ organization.
137159

138-
- 2020-09-15: The repository is moved to the `gbdev <https://github.com/gbdev>`__
139-
organization. The `rgbds.gbdev.io <https://rgbds.gbdev.io>`__ website serving documentation
140-
and downloads is created.
160+
- 2022-05-17: The `rgbds.gbdev.io <https://rgbds.gbdev.io>`__ website for RGBDS
161+
documentation and downloads is published.
141162

142163
4. Acknowledgements
143164
-------------------

0 commit comments

Comments
 (0)