From 56bea083f966306c49156d38f5c5d15d010994e9 Mon Sep 17 00:00:00 2001 From: Brigham Campbell Date: Sun, 4 Oct 2020 12:04:59 -0600 Subject: [PATCH] Add directory summary to README.rst --- README.rst | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 54 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 102561a3..f01c2eac 100644 --- a/README.rst +++ b/README.rst @@ -36,8 +36,60 @@ is possible using ``make`` or ``cmake``; follow the link for more detailed instr 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