Commit Graph

118 Commits

Author SHA1 Message Date
bbbbbr
a84a5021c5 Docs: Fix typo 2021-12-19 10:11:11 -08:00
bbbbbr
461eb2d79b Docs:
* Fix name for BGP, OBP0, OBP1 register references
* Fix LCDC bit reference
* FAQ: note about how to relocate the start of DATA and the Shadow OAM
* Rmove outdated/incorrect info about function start and end symbols for copying functions
2021-12-15 23:24:49 -08:00
bbbbbr
84874207c2 Docs: Note that move_metasprite_*flip() are only available for GB and related clones 2021-12-15 21:48:29 -08:00
bbbbbr
1fdacdbd8d Docs: Getting Started and Supported Consoles
* Getting Started: Fix naming and steps for Windows without make (compile.bat)
* Supported Consoles: Add Megaduck
2021-12-15 17:27:30 -08:00
Toxa
087296eeec update ChangeLog 2021-09-24 16:34:16 +03:00
Toxa
dd598281dd update docs 2021-09-24 16:34:00 +03:00
bbbbbr
0b20faf222 Docs: update PDF manual for 4.0.5 2021-09-23 23:59:40 -07:00
bbbbbr
a9657df0a3 Docs: rle_decompress and related 2021-09-23 20:06:03 -07:00
bbbbbr
4e3f5e71fb Docs: doxygen config: turn on #define of __TARGET_gb to find more fnctions 2021-09-23 19:53:47 -07:00
bbbbbr
c360d8a226 gbcompress: add block style rle compression 2021-09-23 16:31:31 -07:00
bbbbbr
8b721c3cb0 Docs: 4.0.5 Add known issue about cross platform banks example on macOS 2021-09-22 15:15:27 -07:00
bbbbbr
0a24206258 Docs: 4.0.5 - doxygen formatting for ifdef 2021-09-22 14:54:50 -07:00
bbbbbr
47aa245e90 Docs: 4.0.5
- Add lack of -boN and -baN support for windows as a known issue
- Mention fix for get_bkg_tile_xy
2021-09-22 14:53:04 -07:00
bbbbbr
625679bb6f Docs: update note changelog note about USE_SFR_FOR_REG to be more explicit 2021-09-21 21:41:40 -07:00
bbbbbr
d1123a5f22 Docs: updates for 4.0.5
- Formatting fix for toolchain page
- Add note about header files that moved from gb to gbdk dir
2021-09-19 20:58:23 -07:00
bbbbbr
6bb46a75fd Docs: toolchain updates for 4.0.5
- Update some notes about building without lcc and directly using the sdcc tools
- Add sdldz80 and sdasz80 to toolchain help output page (updated main makefile to generate it, plus updated output)
2021-09-19 00:35:06 -07:00
bbbbbr
d5f23ceebd Docs: png2asset updates, harmonize manual and readme.md 2021-09-18 23:56:56 -07:00
bbbbbr
08c512f056 Docs: list z80instructionSize warning as a known issue 2021-09-18 23:56:56 -07:00
bbbbbr
755169d314 Docs: minor format fixes 2021-09-17 22:01:03 -07:00
bbbbbr
b5666b2d40 Docs: 4.0.5 updates - mostly cross platform page 2021-09-17 21:27:42 -07:00
bbbbbr
c656795a66 Docs: supported consoles / cross-platform updates 2021-09-16 01:00:31 -07:00
bbbbbr
ac339077e4 Docs: misc updates for 4.0.5
- add SMS Power! link
- doxygen can't find BANKED and NONBANKED refs, so change their formatting
2021-09-16 00:39:09 -07:00
bbbbbr
6b1fcf3a7b Move ChangeLog and README from /gbdk-support to /docs 2021-09-10 23:08:30 -07:00
bbbbbr
a2e0338d98 Docs: misc updates
- Historical Authors
- Remove outdated autobanking / bankpack limitation
2021-09-10 21:33:44 -07:00
bbbbbr
3bcf682666 Docs: updates for interrupts and banking 2021-09-10 21:33:44 -07:00
Toxa
831266884b update docs 2021-09-10 11:47:31 +03:00
bbbbbr
ef7e100361 Docs: Doxygen config: Define __PORT_gbz80
- Fixes issue where function definitions would be ignored if no valid PORT was defined
- Defaults to GB Port for documentation when required
- See: PREDEFINED = __PORT_gbz80
2021-09-09 23:52:30 -07:00
bbbbbr
06e2f31954 Docs: Fix misc doxygen warnings and duplicate entries 2021-09-09 23:50:37 -07:00
bbbbbr
f43ac19fae Docs: markdown page updates for 4.0.5 2021-09-09 23:35:12 -07:00
bbbbbr
fafd6cb5de Docs: Add DEVICE_* hardware constants to cross platform page 2021-09-08 23:28:57 -07:00
bbbbbr
0ec10d6f18 Docs: misc updates (fixed point, release notes) 2021-09-08 22:30:12 -07:00
bbbbbr
34137b992f Docs: Updates for new SWITCH_ROM and SWITCH_RAM 2021-09-08 20:23:39 -07:00
bbbbbr
353968d16b Docs: Cross Platform: AP compatibility 2021-09-08 20:19:23 -07:00
bbbbbr
4ea7eca08c Docs: ISR_VECTOR() and related
- Improve ISR_VECTOR() description
- Mention it under the custom ISR dispatcher section
2021-09-08 17:12:27 -07:00
bbbbbr
e01c13d286 Docs: updates for 4.0.5
- Updates due to change in variable initialization
2021-09-08 14:54:19 -07:00
bbbbbr
f6b3bf7ef6 Docs: continuing 4.0.5 updates 2021-09-07 00:08:52 -07:00
bbbbbr
98e81e32e5 Docs: Overview updates 2021-09-06 22:07:39 -07:00
bbbbbr
ba19facce6 Docs: Initial updates for 4.0.5 release 2021-09-06 00:45:13 -07:00
Toxa
1a02e4505c update docs 2021-09-03 23:18:07 +03:00
Toxa
49429638d1 update docs 2021-08-29 11:27:12 +03:00
bbbbbr
1f61111fe2 Docs: Tools: CI-CD: A couple phrasing edits and change doxygen anchors 2021-08-28 19:48:49 -07:00
Sebastian Weiß
c1a2e6eb9c Add ci/cd section with gbdk github action builder 2021-08-28 13:40:10 +02:00
Tim Gates
752aa410e2 docs: Fix a few typos
There are small typos in:
- docs/pages/04_coding_guidelines.md
- docs/pages/docs_index.md
- gbdk-lib/examples/ap/gb-dtmf/gb-dtmf.c
- gbdk-lib/examples/ap/metasprites/metasprites.c
- gbdk-lib/examples/gb/gb-dtmf/gb-dtmf.c
- gbdk-lib/examples/gb/metasprites/metasprites.c
- gbdk-lib/examples/gg/metasprites/metasprites.c
- gbdk-lib/examples/sms/metasprites/metasprites.c
- gbdk-lib/libc/time.c
- gbdk-support/gbcompress/gbcompress.c

Fixes:
- Should read `updates` rather than `udpates`.
- Should read `following` rather than `followin`.
- Should read `processing` rather than `procesing`.
- Should read `large` rather than `larege`.
- Should read `documentation` rather than `documenation`.
- Should read `completely` rather than `completly`.
2021-08-22 09:18:38 +10:00
bbbbbr
a6c581e3ea Building: change make.bat generation to compile.bat 2021-08-15 23:04:55 -07:00
bbbbbr
ef29520b71 Merge pull request #214 from bbbbbr/docs_autobanks
Autobanks docs and example - misc improvements
2021-07-24 14:12:43 -07:00
bbbbbr
9e3863819e Autobanks:
- Adjust autobanking example to make it clear that BANKREF() entries can go above their relevant functions, add a couple explanatory comments
- Docs: update to use BANKREF() instead of const void __at(255) ...
- gb.h: Fill out BANKREF_EXTERN docs a little, fix a couple typos
2021-07-24 14:04:38 -07:00
bbbbbr
8d79fc6949 Docs: Getting Started: Add first step - download the release and unzip it 2021-07-23 23:08:25 -07:00
bbbbbr
a59335c739 docs: faq: Add link to global list of functions and variables 2021-06-23 20:30:16 -07:00
bbbbbr
1b909b35a1 Docs: Add note about -yoA auto bank sizing 2021-06-23 19:04:15 -07:00
bbbbbr
25e71470b4 Minor docs edits 2021-06-22 16:16:06 -07:00