cscg22-gearboy

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

README (2611B)

      1
      2        ------------------------------------------------------
      3        GBDK-2020 - https://github.com/gbdk-2020/gbdk-2020
      4        ------------------------------------------------------
      5
      6What's New
      7------------
      8See the "ChangeLog" included in the root folder of the GBDK install.
      9
     10
     11
     12New Releases
     13------------
     14Check for new releases online:
     15https://github.com/gbdk-2020/gbdk-2020/releases
     16
     17
     18
     19Setup:
     20------------
     21
     22=== Windows ===
     23
     24* Unzip to a folder of your choice (which you've probably already done)
     25    Suggested location: c:\gbdk\
     26
     27* Recommended but not required: Add the gbdk 'bin' sub-directory to your
     28  system path using the Windows System control panel
     29
     30* Open a command line and compile the examples by running "compile.bat" in
     31  the "examples\gb" sub-directory:
     32    cd c:\gbdk\examples\gb
     33    compile.bat
     34
     35
     36=== Linux ===
     37
     38* Unzip to a folder of your choice (which you've probably already done)
     39    Suggested location: /opt/gbdk/
     40
     41* Recommended but not required: Add the gbdk 'bin' sub-directory to your shell path
     42    Run from command line (only lasts for that session): export GBDKDIR=/opt/gbdk/
     43    Or add that to your shell defaults (permanent)
     44
     45* Open a command line and compile the examples by running "make" in
     46  the "examples/gb" sub-directory:
     47    cd /opt/gbdk/examples/gb
     48    make
     49
     50
     51
     52GBDK is now ready for use.
     53
     54It's recommended to check out the Getting Started docs: 
     55https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_getting_started.html
     56
     57
     58
     59Reporting problems and feature requests
     60---------------------------------------
     611.  Make sure that you have read this README fully.
     62
     632.  Check the online docs, including the Getting Started section
     64    https://gbdk-2020.github.io/gbdk-2020/docs/api
     65    https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_links_and_tools.html#links_help_and_community
     66
     673.  Make sure you have the latest version
     68    https://github.com/gbdk-2020/gbdk-2020/releases
     69
     704.  Check if anyone else has already reported or solved the problem
     71    https://github.com/gbdk-2020/gbdk-2020/issues?q=is%3Aissue+is%3Aclosed
     72
     735.  Ask for help online
     74    https://github.com/gbdk-2020/gbdk-2020#discord-servers
     75
     76
     77Documentation
     78-------------
     79
     80Library documentation:
     81* https://gbdk-2020.github.io/gbdk-2020/docs/api
     82
     83Pandocs
     84* https://gbdev.io/pandocs/
     85
     86Other useful links:
     87* https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_getting_started.html
     88
     89* https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_links_and_tools.html#links_help_and_community
     90    
     91
     92
     93History
     94-------------
     95
     96Original work on GBDK (pre-2020) was by:
     97
     98Pascal Felber, Lars Malmborg, Michael Hope (and perhaps others)