ref: be9b1198e940ed36c95778d30099a11cbf803860
parent: fdfc02ab963ed2ccdcae08cb3ad7231bf9b40bda
parent: 56bea083f966306c49156d38f5c5d15d010994e9
author: Eldred Habert <[email protected]>
date: Sun Oct 4 16:20:08 EDT 2020
Merge pull request #584 from Xeyler/master Add directory summary to README.rst
--- a/README.rst
+++ b/README.rst
@@ -36,8 +36,60 @@
cmake --build build
cmake --install build
-2. History
----------
+2. RGBDS Folder Organization
+----------------------------
+
+The RGBDS source code file structure somewhat resembles the following:
+
+::
+
+ .
+ ├── .github/
+ │ ├── actions/
+ │ │ └── ...
+ │ └── workflows/
+ │ └── ...
+ ├── contrib/
+ │ └── ...
+ ├── include/
+ │ └── ...
+ ├── src/
+ │ ├── asm/
+ │ │ └── ...
+ │ ├── extern/
+ │ │ └── ...
+ │ ├── fix/
+ │ │ └── ...
+ │ ├── gfx/
+ │ │ └── ...
+ │ ├── link/
+ │ │ └── ...
+ │ ├── CMakeLists.txt
+ │ └── ...
+ ├── test/
+ │ ├── ...
+ │ └── run-tests.sh
+ ├── CMakeLists.txt
+ ├── Makefile
+ └── README.rst
+
+- ``.github/`` - files and scripts related to the integration of the RGBDS codebase with
+ GitHub.
+
+- ``contrib/`` - scripts and other resources which may be useful to users and developers of
+ RGBDS.
+
+- ``include/`` - header files for each respective C files in `src`.
+
+- ``src/`` - source code and manual pages for RGBDS.
+
+ * Note that the code unique to each RGBDS tool is stored in its respective subdirectory
+ (rgbasm -> ``src/asm/``, for example). ``src/extern/`` contains code imported from external sources.
+
+- ``test/`` - testing framework used to verify that changes to the code don't break or modify the behavior of RGBDS.
+
+3. History
+----------
- Around 1997, Carsten Sørensen (AKA SurfSmurf) writes ASMotor as a
general-purpose assembler/linker system for DOS/Win32