millfork/docs/README.md

Documentation

★ WORK IN PROGRESS ★

Compiler usage

• Getting started

• Command-line option reference

• Target platform reference

• Defining a custom platform

Language reference

• Preprocessor

• Syntax

• Types

• Literals

• List of text encodings and escape sequences

• Operators reference

• Functions

• Inline 6502 assembly syntax

• Inline 8080/LR35902/Z80 assembly syntax

• Important guidelines regarding reentrancy

Library reference

• stdlib module

• string module

• Modules for reading input devices

• Other cross-platform modules (err, stdio, random)

• Definitions available on only some platforms

• C64-only modules

• cbm_file module

• NES-only modules

Implementation details

• Variable storage

• Calling convention

• Undefined behaviour

• Undocumented instruction support

• Reference for labels in generated assembly code