gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/README
1
2 ------------------------------------------------------
3 GBDK-2020 - https://github.com/gbdk-2020/gbdk-2020
4 ------------------------------------------------------
5
6 What's New
7 ------------
8 See the "ChangeLog" included in the root folder of the GBDK install.
9
10
11
12 New Releases
13 ------------
14 Check for new releases online:
15 https://github.com/gbdk-2020/gbdk-2020/releases
16
17
18
19 Setup:
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:
42 - Add the gbdk 'bin' sub-directory to your shell path. For example: export PATH=$PATH:/opt/gbdk/bin
43 - These can be set temporarily in the current shell or added to your shell defaults permanently.
44
45 * Note: The GBDKDIR environment variable is not necessary to set in most cases. When lcc is
46 called it will attempt to determine the current working directory automatically on it's own.
47 When GBDKDIR is used it requires a trailing slash, for example: export GBDKDIR=/opt/gbdk/
48
49 * Open a command line and compile the examples by running "make" in
50 the "examples/gb" sub-directory:
51 cd /opt/gbdk/examples/gb
52 make
53
54
55
56 GBDK is now ready for use.
57
58 It's recommended to check out the Getting Started docs:
59 https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_getting_started.html
60
61
62
63 Reporting problems and feature requests
64 ---------------------------------------
65 1. Make sure that you have read this README fully.
66
67 2. Check the online docs, including the Getting Started section
68 https://gbdk-2020.github.io/gbdk-2020/docs/api
69 https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_links_and_tools.html#links_help_and_community
70
71 3. Make sure you have the latest version
72 https://github.com/gbdk-2020/gbdk-2020/releases
73
74 4. Check if anyone else has already reported or solved the problem
75 https://github.com/gbdk-2020/gbdk-2020/issues?q=is%3Aissue+is%3Aclosed
76
77 5. Ask for help online
78 https://github.com/gbdk-2020/gbdk-2020#discord-servers
79
80
81 Documentation
82 -------------
83
84 Library documentation:
85 * https://gbdk-2020.github.io/gbdk-2020/docs/api
86
87 Pandocs
88 * https://gbdev.io/pandocs/
89
90 Other useful links:
91 * https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_getting_started.html
92
93 * https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_links_and_tools.html#links_help_and_community
94
95
96
97 History
98 -------------
99
100 Original work on GBDK (pre-2020) was by:
101
102 Pascal Felber, Lars Malmborg, Michael Hope (and perhaps others)
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.