1
0
mirror of https://github.com/KarolS/millfork.git synced 2024-12-24 15:29:23 +00:00
millfork/docs/README.md

107 lines
2.4 KiB
Markdown
Raw Normal View History

2019-07-15 11:52:05 +00:00
# Documentation index
2018-04-02 22:21:26 +00:00
2019-07-15 11:52:05 +00:00
* [Home page](index.md)
2018-04-02 22:21:26 +00:00
## Compiler usage
* [Getting started](api/getting-started.md)
* [Command-line option reference](api/command-line.md)
* [Target platform reference](api/target-platforms.md)
2018-07-24 22:04:00 +00:00
* [Defining a custom platform](api/custom-platform.md)
2018-04-02 22:21:26 +00:00
## Language reference
2018-07-24 22:04:00 +00:00
* [Preprocessor](lang/preprocessor.md)
2020-06-03 21:13:17 +00:00
* [Modules](lang/modules.md)
2018-04-02 22:21:26 +00:00
* [Syntax](lang/syntax.md)
* [Types](lang/types.md)
* [Literals](lang/literals.md)
2019-09-03 23:14:14 +00:00
* [Predefined constants](lang/predefined_constants.md)
* [List of text encodings and escape sequences](lang/text.md)
2018-04-02 22:21:26 +00:00
* [Operators reference](lang/operators.md)
* [Functions](lang/functions.md)
2018-07-24 22:04:00 +00:00
* [Inline 6502 assembly syntax](lang/assembly.md)
* [Inline 8080/LR35902/Z80 assembly syntax](lang/assemblyz80.md)
2018-04-02 22:21:26 +00:00
2020-03-31 17:07:35 +00:00
* [Inline 6809 assembly syntax](lang/assembly6809.md)
2018-04-02 22:21:26 +00:00
* [Important guidelines regarding reentrancy](lang/reentrancy.md)
* [List of keywords](lang/keywords.md)
2018-07-24 22:04:00 +00:00
## Library reference
* [`stdlib` module](stdlib/stdlib.md)
2020-04-05 22:44:20 +00:00
* [`string`, `scrstring` and `pstring` modules](stdlib/string.md)
2019-06-05 09:46:06 +00:00
* [`stdio` module](stdlib/stdio.md)
2020-03-31 17:07:35 +00:00
* Reading input devices:
2018-07-24 22:04:00 +00:00
2020-03-31 17:07:35 +00:00
* [`joy` module](stdlib/joy.md)
2018-07-24 22:04:00 +00:00
2020-03-31 17:07:35 +00:00
* [`keyboard` module](stdlib/keyboard.md)
2019-01-05 00:19:14 +00:00
2020-03-31 17:07:35 +00:00
* [`mouse` module](stdlib/mouse.md)
2018-04-02 22:21:26 +00:00
2020-03-31 17:07:35 +00:00
* [`encconv` module](stdlib/encconv.md)
2019-03-18 22:15:28 +00:00
2020-03-31 17:07:35 +00:00
* [Other cross-platform modules (`err`, `random`)](stdlib/other.md)
* Platform-specific modules:
* [Definitions available on only some platforms](stdlib/frequent.md)
* [C64-only modules](stdlib/c64.md)
* [PET-only modules](stdlib/cbm_pet.md)
* [`cbm_file` module](stdlib/cbm_file.md)
* [NES-only modules](stdlib/nes.md)
* [Atari Lynx-only modules](stdlib/lynx.md)
* [Game Boyonly modules](stdlib/gb.md)
* [X16only modules](stdlib/x16.md)
2019-09-16 20:55:08 +00:00
2018-04-02 22:21:26 +00:00
## Implementation details
* [Variable storage](abi/variable-storage.md)
2018-07-24 22:04:00 +00:00
* [Calling convention](abi/calling-convention.md)
2018-04-02 22:21:26 +00:00
* [Undefined behaviour](abi/undefined-behaviour.md)
* [Undocumented instruction support](abi/undocumented.md)
* [Reference for labels in generated assembly code](abi/generated-labels.md)
2019-07-15 11:52:05 +00:00
## External links
* [Example programs](https://github.com/KarolS/millfork/tree/master/examples)
* [Millfork wiki](https://github.com/KarolS/millfork/wiki)
* [Benchmarks](https://github.com/KarolS/millfork-benchmarks)
* [Downloads](https://github.com/KarolS/millfork/releases/)
* [Source code](https://github.com/KarolS/millfork)