cscg22-gearboy

CSCG 2022 Challenge 'Gearboy'
git clone https://git.sinitax.com/sinitax/cscg22-gearboy
Log | Files | Refs | sfeed.txt

docs_index.md (2598B)

      1@mainpage General Documentation
      2
      3@anchor docs_index
      4- @subpage docs_getting_started
      5- @subpage docs_links_and_tools
      6- @subpage docs_using_gbdk
      7- @subpage docs_coding_guidelines
      8- @subpage docs_rombanking_mbcs
      9- @subpage docs_supported_consoles
     10- @subpage docs_toolchain
     11- @subpage docs_example_programs
     12- @subpage docs_faq
     13- @subpage docs_migrating_versions
     14- @subpage docs_releases
     15- @subpage docs_toolchain_settings
     16
     17
     18
     19# Introduction
     20Welcome to GBDK-2020! The best thing to do is head over to the @ref docs_getting_started "Getting Started" section to get up and running.
     21
     22
     23# About the Documentation
     24This documentation is partially based on material written by the original GBDK authors in 1999 and updated for GBDK-2020. The API docs are automatically generated from the C header files using Doxygen.
     25
     26GBDK-2020 is an updated version of the original GBDK with a modernized SDCC toolchain and many API improvements and fixes. It can be found at: https://github.com/gbdk-2020/gbdk-2020/.
     27
     28The original GBDK sources, documentation and website are at: http://gbdk.sourceforge.net/
     29
     30
     31# About GBDK
     32The GameBoy Developer's Kit (GBDK, GBDK-2020) is used to develop games and programs for the Nintendo Game Boy (and some other consoles) in C and assembly. GBDK includes a set of libraries for the most common requirements and generates image files for use with a real GameBoy or emulators.
     33
     34GBDK features:
     35 - C and ASM toolchain based on SDCC with some support utilities
     36 - A set of libraries with source code
     37 - Example programs in ASM and in C
     38 - Support for multiple ROM bank images and auto-banking
     39 - Support for multiple consoles: Game Boy, Analogue Pocket, Mega Duck, Master System and Game Gear
     40
     41GBDK is freeware. Most of the tooling code is under the GPL. The runtime libraries should be under the LGPL. Please consider mentioning GBDK in the credits of projects made with it.
     42
     43- - - - - -
     44
     45# Historical Info and Links
     46
     47Work on the original GBDK (pre-2020) was by:
     48
     49Pascal Felber, Lars Malmborg, Michael Hope, David Galloway (djmips), and others.
     50
     51
     52The following is from the original GBDK documentation:
     53
     54Thanks to quang for many of the comments to the gb functions.  Some
     55of the comments are ripped directly from the Linux Programmers
     56manual, and some directly from the pan/k00Pa document.
     57
     58<a href="http://quangdx.com/">quangDX.com</a>
     59
     60<a href="http://gbdk.sourceforge.net/">The (original) gbdk homepage</a>
     61
     62<a href="http://www.devrs.com/gb/">Jeff Frohwein's GB development page.</a>
     63A extensive source of Game Boy related information, including GeeBee's GB faq and the pan/k00Pa document.
     64