Skip to content

Commit 289910f

Browse files
Rangi42ISSOtm
Rangi42
authored and
ISSOtm
committed
Convert reStructuredText to Markdown
1 parent f1b6ef2 commit 289910f

File tree

7 files changed

+260
-326
lines changed

7 files changed

+260
-326
lines changed

CONTRIBUTING.rst renamed to CONTRIBUTING.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,30 @@
1-
Contributing
2-
============
1+
# Contributing
32

43
RGBDS was created in the late '90s and has received contributions from several
54
developers since then. It wouldn't have been possible to get to this point
65
without their work, and it is always open to the contributions of other people.
76

8-
Reporting Bugs
9-
--------------
7+
## Reporting Bugs
108

119
Bug reports are essential to improve RGBDS and they are always welcome. If you
1210
want to report a bug:
1311

1412
1. Make sure that there isn't a similar issue already reported
15-
`here <https://github.com/gbdev/rgbds/issues>`__.
16-
13+
[here](https://github.com/gbdev/rgbds/issues).
1714
2. Figure out a way of reproducing it reliably.
18-
1915
3. If there is a piece of code that triggers the bug, try to reduce it to the
2016
smallest file you can.
21-
22-
4. Create a new `issue <https://github.com/gbdev/rgbds/issues>`__.
17+
4. Create a new [issue](https://github.com/gbdev/rgbds/issues).
2318

2419
Of course, it may not always be possible to give an accurate bug report, but it
2520
always helps to fix it.
2621

27-
Requesting new features
28-
-----------------------
22+
## Requesting new features
2923

3024
If you come up with a good idea that could be implemented, you can propose it to
3125
be done.
3226

33-
1. Create a new `issue <https://github.com/gbdev/rgbds/issues>`__.
34-
27+
1. Create a new [issue](https://github.com/gbdev/rgbds/issues).
3528
2. Try to be as accurate as possible. Describe what you need and why you need
3629
it, maybe with examples.
3730

@@ -40,16 +33,15 @@ simple requests are more likely to catch the interest of a contributor than
4033
complicated ones. If you really need something to be done, and you think you can
4134
implement it yourself, you can always contribute to RGBDS with your own code.
4235

43-
Contributing code
44-
-----------------
36+
## Contributing code
4537

4638
If you want to contribute with your own code, whether it is to fix a current
4739
issue or to add something that nobody had requested, you should first consider
4840
if your change is going to be small (and likely to be accepted as-is) or big
4941
(and will have to go through some rework).
5042

5143
Big changes will most likely require some discussion, so open an
52-
`issue <https://github.com/gbdev/rgbds/issues>`__ and explain what you want to
44+
[issue](https://github.com/gbdev/rgbds/issues) and explain what you want to
5345
do and how you intend to do it. If you already have a prototype, it's always a
5446
good idea to show it. Tests help, too.
5547

@@ -59,25 +51,19 @@ but doesn't know that there's someone working on it.
5951

6052
Note that you must contribute all your changes under the MIT License. If you are
6153
just modifying a file, you don't need to do anything (maybe update the copyright
62-
years). If you are adding new files, you need to use the ``SPDX-License-Identifier: MIT``
54+
years). If you are adding new files, you need to use the `SPDX-License-Identifier: MIT`
6355
header.
6456

6557
1. Fork this repository.
66-
67-
2. Checkout the ``master`` branch.
68-
69-
3. Create a new branch to work on. You could still work on ``master``, but it's
58+
2. Checkout the `master` branch.
59+
3. Create a new branch to work on. You could still work on `master`, but it's
7060
easier that way.
71-
72-
4. Compile your changes with ``make develop`` instead of just ``make``. This
61+
4. Compile your changes with `make develop` instead of just `make`. This
7362
target checks for additional warnings. Your patches shouldn't introduce any
7463
new warning (but it may be possible to remove some warning checks if it makes
7564
the code much easier).
76-
77-
5. Format your changes according to ``clang-format``, which will reformat the
78-
coding style according to our standards defined in ``.clang-format``.
79-
80-
6. Create a pull request against the branch ``master``.
81-
65+
5. Format your changes according to `clang-format`, which will reformat the
66+
coding style according to our standards defined in `.clang-format`.
67+
6. Create a pull request against the branch `master`.
8268
7. Be prepared to get some comments about your code and to modify it. Tip: Use
83-
``git rebase -i origin/master`` to modify chains of commits.
69+
`git rebase -i origin/master` to modify chains of commits.

‎CONTRIBUTORS.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributors to RGBDS
2+
3+
## Original author
4+
5+
- Carsten Elton Sørensen &lt;[email protected]&gt;
6+
7+
## Main contributors
8+
9+
- Justin Lloyd &lt;[email protected]&gt;
10+
- Vegard Nossum &lt;[email protected]&gt;
11+
- Anthony J. Bentley &lt;[email protected]&gt;
12+
- stag019 &lt;[email protected]&gt;
13+
- Antonio Niño Díaz &lt;[email protected]&gt;
14+
- Eldred "ISSOtm" Habert &lt;[email protected]&gt;
15+
- Sylvie "Rangi" Oukaour &lt;http://github.com/Rangi42&gt;
16+
17+
## Other contributors
18+
19+
- Ben Hetherington &lt;[email protected]&gt;
20+
- Björn Höhrmann &lt;[email protected]&gt;
21+
- Christophe Staïesse &lt;[email protected]&gt;
22+
- David Brotz &lt;[email protected]&gt;
23+
- Jakub Kądziołka &lt;[email protected]&gt;
24+
- James "JL2210" Larrowe &lt;https://github.com/JL2210&gt;
25+
- The Musl C library &lt;http://www.musl-libc.org&gt;
26+
- obskyr &lt;[email protected]&gt;
27+
- The OpenBSD Project &lt;http://www.openbsd.org&gt;
28+
- Quint Guvernator &lt;[email protected]&gt;
29+
- Sanqui &lt;[email protected]&gt;
30+
- YamaArashi &lt;[email protected]&gt;
31+
- yenatch &lt;[email protected]&gt;
32+
- phs &lt;[email protected]&gt;
33+
- jidoc01 &lt;[email protected]&gt;

‎CONTRIBUTORS.rst‎

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎README.md‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# RGBDS
2+
3+
RGBDS (Rednex Game Boy Development System) is a free assembler/linker package
4+
for the Game Boy and Game Boy Color. It consists of:
5+
6+
- rgbasm (assembler)
7+
- rgblink (linker)
8+
- rgbfix (checksum/header fixer)
9+
- rgbgfx (PNG‐to‐Game Boy graphics converter)
10+
11+
This is a fork of the original RGBDS which aims to make the programs more like
12+
other UNIX tools.
13+
14+
This toolchain is maintained [on GitHub](https://github.com/gbdev/rgbds).
15+
16+
The documentation of this toolchain can be viewed online [here](https://rgbds.gbdev.io/docs/).
17+
It is generated from the man pages found in this repository.
18+
The source code of the website itself is on GitHub as well under the repo
19+
[rgbds-www](https://github.com/gbdev/rgbds-www).
20+
21+
If you want to contribute or maintain RGBDS, and have questions regarding the code, its
22+
organisation, etc. you can find the maintainers [on the gbdev community channels](https://gbdev.io/chat)
23+
or via mail at `rgbds at gbdev dot io`.
24+
25+
## 1. Installing RGBDS
26+
27+
The [installation procedure](https://rgbds.gbdev.io/install) is available
28+
online for various platforms. [Building from source](https://rgbds.gbdev.io/install/source)
29+
is possible using `make` or `cmake`; follow the link for more detailed instructions.
30+
31+
```sh
32+
make
33+
sudo make install
34+
```
35+
36+
```sh
37+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
38+
cmake --build build
39+
cmake --install build
40+
```
41+
42+
## 2. RGBDS Folder Organization
43+
44+
The RGBDS source code file structure is as follows:
45+
46+
```
47+
.
48+
├── .github/
49+
│ ├── scripts/
50+
│ │ └── ...
51+
│ └── workflows/
52+
│ └── ...
53+
├── contrib/
54+
│ ├── zsh_compl/
55+
│ │ └── ...
56+
│ └── ...
57+
├── include/
58+
│ └── ...
59+
├── man/
60+
│ └── ...
61+
├── src/
62+
│ ├── asm/
63+
│ │ └── ...
64+
│ ├── extern/
65+
│ │ └── ...
66+
│ ├── fix/
67+
│ │ └── ...
68+
│ ├── gfx/
69+
│ │ └── ...
70+
│ ├── link/
71+
│ │ └── ...
72+
│ ├── CMakeLists.txt
73+
│ └── ...
74+
├── test/
75+
│ ├── ...
76+
│ └── run-tests.sh
77+
├── .clang-format
78+
├── CMakeLists.txt
79+
├── Dockerfile
80+
├── Makefile
81+
└── README.md
82+
```
83+
84+
- `.github/` - files and scripts related to the integration of the RGBDS codebase with
85+
GitHub.
86+
* `scripts/` - scripts used by workflow files.
87+
* `workflows/` - CI workflow description files.
88+
- `contrib/` - scripts and other resources which may be useful to users and developers of
89+
RGBDS.
90+
* `zsh_compl` contains tab completion scripts for use with zsh. Put them somewhere in
91+
your `fpath`, and they should auto-load.
92+
* `bash_compl` contains tab completion scripts for use with bash. Run them with `source`
93+
somewhere in your `.bashrc`, and they should load every time you open a shell.
94+
- `include/` - header files for the respective source files in `src`.
95+
- `man/` - manual pages.
96+
- `src/` - source code of RGBDS.
97+
* Note that the code unique to each RGBDS tool is stored in its respective subdirectory
98+
(rgbasm's code is in `src/asm/`, for example). `src/extern/` contains code imported from
99+
external sources.
100+
- `test/` - testing framework used to verify that changes to the code don't break or
101+
modify the behavior of RGBDS.
102+
- `.clang-format` - code style for automated C++ formatting with
103+
[`clang-format`](https://clang.llvm.org/docs/ClangFormat.html).
104+
- `Dockerfile` - defines how to build RGBDS with Docker.
105+
106+
## 3. History
107+
108+
- 1996-10-01: Carsten Sørensen (a.k.a. SurfSmurf) releases
109+
[xAsm](http://otakunozoku.com/RGBDSdocs/asm.htm),
110+
[xLink](http://otakunozoku.com/RGBDSdocs/link.htm), and
111+
[RGBFix](http://otakunozoku.com/RGBDSdocs/fix.htm),
112+
a Game Boy SM83 (GBZ80) assembler/linker system for DOS/Win32.
113+
- 1997-07-03: Sørensen releases [ASMotor](http://otakunozoku.com/RGBDSdocs/geninfo.htm),
114+
packaging the three programs together and moving towards making them a
115+
general-purpose target-independent system.
116+
- 1999-08-01: Justin Lloyd (a.k.a. Otaku no Zoku) adapts ASMotor to re-focus
117+
on SM83 assembly/machine code, and releases this version as
118+
[RGBDS](http://otakunozoku.com/rednex-gameboy-development-system/).
119+
- 2009-06-11: Vegard Nossum adapts the code to be more UNIX-like and releases
120+
this version as [rgbds-linux](https://github.com/vegard/rgbds-linux).
121+
- 2010-01-12: Anthony J. Bentley [forks](https://github.com/bentley) Nossum's
122+
repository. The fork becomes the reference implementation of RGBDS.
123+
- 2015-01-18: stag019 begins implementing [rgbgfx](https://github.com/stag019/rgbgfx),
124+
a PNG‐to‐Game Boy graphics converter, for eventual integration into RGBDS.
125+
- 2016-09-05: rgbgfx is [integrated](https://github.com/gbdev/rgbds/commit/c3c31138ddbd8680d4e67957e387f2816798a71b)
126+
into Bentley's repository.
127+
- 2017-02-23: Bentley's repository is moved to the [rednex](https://github.com/rednex)
128+
organization.
129+
- 2018-01-26: The codebase is [relicensed](https://github.com/gbdev/rgbds/issues/128)
130+
under the MIT license.
131+
- 2020-09-15: The repository is [moved](https://github.com/gbdev/rgbds/issues/567)
132+
to the [gbdev](https://github.com/gbdev) organization.
133+
- 2022-05-17: The [rgbds.gbdev.io](https://rgbds.gbdev.io) website for RGBDS
134+
documentation and downloads is published.
135+
136+
## 4. Acknowledgements
137+
138+
RGBGFX generates palettes using algorithms found in the paper
139+
["Algorithms for the Pagination Problem, a Bin Packing with Overlapping Items"](http://arxiv.org/abs/1605.00558)
140+
([GitHub](https://github.com/pagination-problem/pagination), MIT license),
141+
by Aristide Grange, Imed Kacem, and Sébastien Martin.
142+
143+
RGBGFX's color palette was taken from [SameBoy](https://sameboy.github.io), with permission and help
144+
by [LIJI](https://github.com/LIJI32).

0 commit comments

Comments
 (0)