gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
commit 439f35106c6ec595611e0aeac2f3a7f6575d632f parent 49bd4a2a1c257ab581418e2391eb33f759a85a66 Author: bbbbbr <reg+github@roughhousing.com> Date: Thu, 16 Dec 2021 14:08:57 -0800 Docs: Root Readme: Update to new style * Merge in improved layout proposed by @wujood * Fix changelog link * Improve some phrasing and re-arrange sections * Add Mega Duck to supported console list Diffstat:
| M | README.md | 68 | +++++++++++++++++++++++++++++++++++++++----------------------------- |
1 file changed, 39 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md @@ -1,47 +1,44 @@ -## Current release for Windows: [WINDOWS Binaries](https://github.com/gbdk-2020/gbdk-2020/releases/latest/download/gbdk-win.zip) -## Current release for MacOS: [MacOS Binaries](https://github.com/gbdk-2020/gbdk-2020/releases/latest/download/gbdk-macos.zip) -## Current release for Linux: [Linux Binaries](https://github.com/gbdk-2020/gbdk-2020/releases/latest/download/gbdk-linux64.tar.gz) -You don't need the sources, unless you wish to compile GBDK-2020 yourself. Download the current release binaries using the links above. +# GBDK-2020 +GBDK is a cross-platform development kit for sm83 and z80 based gaming consoles. It includes libraries, toolchain utilities and the [SDCC](http://sdcc.sourceforge.net/) C compiler suite. -Upgrading to a new version? Check the [Migration notes](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_migrating_versions.html). +__Supported Consoles:__ [(see docs)](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_supported_consoles.html) +- Nintendo Gameboy +- Analogue Pocket +- Sega Master System & Game Gear +- Mega Duck / Cougar Boy -# Docs -Online documentation is avaliable [HERE](https://gbdk-2020.github.io/gbdk-2020/docs/api) +## Current Release +<a href="https://github.com/gbdk-2020/gbdk-2020/releases/latest/download/gbdk-win.zip"><img src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white" alt="GBDK-2020 Windows Release"></a> +<a href="https://github.com/gbdk-2020/gbdk-2020/releases/latest/download/gbdk-linux64.tar.gz"><img src="https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black" alt="GBDK-2020 Linux Release"></a> +<a href="https://github.com/gbdk-2020/gbdk-2020/releases/latest/download/gbdk-macos.zip"><img src="https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=apple&logoColor=white" alt="GBDK-2020 MacOS Release"></a> -A good place to start is the [Getting Started Section](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_getting_started.html). +<!-- <a href="https://hub.docker.com"><img src="https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white" alt="Docker"></a> --> -Check the [Links and Third-Party Tools Section](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_links_and_tools.html) for a list of recommended emulators, graphics tools, music drivers and more. +Upgrading to a new version? Check the [Migration notes](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_migrating_versions.html). You can find older versions [here](https://github.com/gbdk-2020/gbdk-2020/releases). -# gbdk-2020 -GBDK is a cross-platform development kit for sm83 and z80 based consoles. It includes libraries, toolchain utilities and the [SDCC](http://sdcc.sourceforge.net/) C compiler suite. +For a full list of changes see the [ChangeLog](https://github.com/gbdk-2020/gbdk-2020/blob/master/docs/ChangeLog) file or [online Docs](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_releases.html). -See the [Supported Consoles & Cross Compiling](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_supported_consoles.html) documentation for more details. -__Supported Consoles:__ -- Nintendo Gameboy -- Analogue Pocket -- Sega Master System & Game Gear +## Build status +[](https://github.com/gbdk-2020/gbdk-2020/actions/workflows/gbdk_build_and_package.yml) -# Current status -- Updated CRT and library that suits better for game development -- SDCC Versions - - GBDK-2020 4.0.5 requires SDCC patches for z80 SMS/Game Gear support. So SDCC nightlies/snapshot builds cannot be used if you want to target SMS/Game Gear. Instead use the [Patched SDCC Builds](https://github.com/gbdk-2020/gbdk-2020-sdcc/releases/tag/sdcc-12539-patched). - - In addition, recent SDCC nightlies/snapshot builds have switched to a new calling convention which is not well tested with GBDK-2020 and there may be bugs. It's recommended to not use versions after build #12539 at this time. -- The compiler driver **lcc** supports the latest sdcc toolchain. -For full list of changes see the [ChangeLog](https://github.com/gbdk-2020/gbdk-2020/blob/master/gbdk-support/ChangeLog) file +## Docs +GBDK includes extensive [documentation](https://gbdk-2020.github.io/gbdk-2020/docs/api). A good place to begin is the [Getting Started Section](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_getting_started.html). -# Origin +Check the [Links and Third-Party Tools Section](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_links_and_tools.html) for a list of recommended emulators, graphics tools, music drivers and more. -Over the years people have been complaining about all the issues caused by a very old version of SDCC (the compiler). This is a proper attempt of updating it while also keeping all the old functionallity working, like support for banked code and data and so on +For SDCC you can check its [website](http://sdcc.sourceforge.net/) and the [manual](http://sdcc.sourceforge.net/doc/sdccman.pdf) -The last version in the OLD repo is [2.96](https://sourceforge.net/projects/gbdk/files/gbdk/2.96/) although releases are available until 2.95-3. Version [2.96](https://sourceforge.net/projects/gbdk/files/gbdk/2.96/) is the starting point of this repo -# Usage +## Usage Most users will only need to download and unzip the latest [release](https://github.com/gbdk-2020/gbdk-2020/releases) -Then go to the examples folder and build them (with compile.bat on windows or running make). They are a good starting point. +Then go to the examples folder and build them (with `compile.bat` on Windows or running `make`). They are a good starting point. + +The sources in this repo are only needed if you want to re-compile GBDK-2020 yourself instead of using the release binaries linked above. + ## Discord servers * [gbdk/zgb Discord](https://discord.gg/XCbjCvqnUY) - For help with using GBDK (and ZGB), discussion and development of gbdk-2020 @@ -53,7 +50,20 @@ Then go to the examples folder and build them (with compile.bat on windows or ru - [The Game Boy Development Forum](https://gbdev.gg8.se/forums/) - A good place to search for Game Boy related answers. - [SMS Power! Forum](https://www.smspower.org/) - Additional SMS & Game Gear discussion and resources. -For SDCC you can check its [website](http://sdcc.sourceforge.net/) and the [manual](http://sdcc.sourceforge.net/doc/sdccman.pdf) + +## Current status +- Updated CRT and library that suits better for game development +- SDCC Versions + - GBDK-2020 4.0.5 requires SDCC patches for z80 SMS/Game Gear support. So SDCC nightlies/snapshot builds cannot be used if you want to target SMS/Game Gear. Instead use the [Patched SDCC Builds](https://github.com/gbdk-2020/gbdk-2020-sdcc/releases/tag/sdcc-12539-patched). + - In addition, recent SDCC nightlies/snapshot builds have switched to a new calling convention which is not well tested with GBDK-2020 and there may be bugs. It's recommended to not use versions after build #12539 at this time. +- The compiler driver **lcc** supports the latest sdcc toolchain. + + +## Origin +Over the years people have been complaining about all the GBDK issues caused by a very old version of SDCC (the compiler). This is a proper attempt of updating it while also keeping all the old functionallity working, like support for banked code and data and so on. + +The last version in the OLD repo is [2.96](https://sourceforge.net/projects/gbdk/files/gbdk/2.96/) although releases are available until 2.95-3. Version [2.96](https://sourceforge.net/projects/gbdk/files/gbdk/2.96/) is the starting point of this repo. + # Build instructions Unless you are interested on recompiling the sources for some reason (like fixing some bugs) **you don't need to build GBDK**
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.