2017-12-06 23:23:30 +00:00
|
|
|
# Documentation
|
|
|
|
|
|
2018-01-04 00:15:04 +00:00
|
|
|
**★ WORK IN PROGRESS ★**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Compiler usage
|
|
|
|
|
|
2018-01-18 21:35:25 +00:00
|
|
|
* [Getting started](api/getting-started.md)
|
|
|
|
|
|
2018-01-04 00:15:04 +00:00
|
|
|
* [Command-line option reference](api/command-line.md)
|
|
|
|
|
|
|
|
|
|
* [Target platform reference](api/target-platforms.md)
|
|
|
|
|
|
2018-07-01 22:45:53 +00:00
|
|
|
* [Defining a custom platform](api/custom-platform.md)
|
|
|
|
|
|
2018-01-04 00:15:04 +00:00
|
|
|
## Language reference
|
|
|
|
|
|
2018-07-12 16:30:35 +00:00
|
|
|
* [Preprocessor](lang/preprocessor.md)
|
|
|
|
|
|
2018-01-18 21:35:25 +00:00
|
|
|
* [Syntax](lang/syntax.md)
|
|
|
|
|
|
|
|
|
|
* [Types](lang/types.md)
|
|
|
|
|
|
2018-07-27 22:58:20 +00:00
|
|
|
* [Literals](lang/literals.md)
|
|
|
|
|
|
|
|
|
|
* [List of text encodings and escape sequences](lang/text.md)
|
|
|
|
|
|
2018-01-18 21:35:25 +00:00
|
|
|
* [Operators reference](lang/operators.md)
|
|
|
|
|
|
|
|
|
|
* [Functions](lang/functions.md)
|
2018-01-10 12:08:24 +00:00
|
|
|
|
2018-07-01 22:31:47 +00:00
|
|
|
* [Inline 6502 assembly syntax](lang/assembly.md)
|
2018-01-04 00:15:04 +00:00
|
|
|
|
2018-07-27 17:07:12 +00:00
|
|
|
* [Inline 8080/LR35902/Z80 assembly syntax](lang/assemblyz80.md)
|
2018-07-12 16:30:35 +00:00
|
|
|
|
2018-01-04 00:15:04 +00:00
|
|
|
* [Important guidelines regarding reentrancy](lang/reentrancy.md)
|
|
|
|
|
|
2018-07-12 16:30:35 +00:00
|
|
|
## Library reference
|
|
|
|
|
|
|
|
|
|
* [`stdlib` module](stdlib/stdlib.md)
|
|
|
|
|
|
2018-12-19 18:01:53 +00:00
|
|
|
* [`string` module](stdlib/string.md)
|
|
|
|
|
|
2018-12-17 16:18:29 +00:00
|
|
|
* [Modules for reading input devices](stdlib/input.md)
|
|
|
|
|
|
2018-12-30 17:59:32 +00:00
|
|
|
* [Other cross-platform modules (`err`, `stdio`, `random`)](stdlib/other.md)
|
2018-07-12 16:30:35 +00:00
|
|
|
|
2018-12-17 16:18:29 +00:00
|
|
|
* [Definitions available on only some platforms](stdlib/frequent.md)
|
|
|
|
|
|
2018-07-12 16:30:35 +00:00
|
|
|
* [C64-only modules](stdlib/c64.md)
|
|
|
|
|
|
|
|
|
|
* [NES-only modules](stdlib/nes.md)
|
2018-01-04 00:15:04 +00:00
|
|
|
|
|
|
|
|
## Implementation details
|
|
|
|
|
|
|
|
|
|
* [Variable storage](abi/variable-storage.md)
|
|
|
|
|
|
2018-07-03 21:28:05 +00:00
|
|
|
* [Calling convention](abi/calling-convention.md)
|
|
|
|
|
|
2018-01-04 00:15:04 +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)
|
