millfork/docs/README.md

Documentation index

• Home page

Compiler usage

• Getting started

• Command-line option reference

• Target platform reference

• Defining a custom platform

Language reference

• Preprocessor

• Syntax

• Types

• Literals

• Predefined constants

• List of text encodings and escape sequences

• Operators reference

• Functions

• Inline 6502 assembly syntax

• Inline 8080/LR35902/Z80 assembly syntax

• Inline 6809 assembly syntax

• Important guidelines regarding reentrancy

• List of keywords

Library reference

• stdlib module

• string, scrstring and pstring modules

• stdio module

• Reading input devices:

  • joy module

  • keyboard module

  • mouse module

• encconv module

• Other cross-platform modules (err, random)

• Platform-specific modules:

  • Definitions available on only some platforms

  • C64-only modules

  • PET-only modules

  • cbm_file module

  • NES-only modules

  • Atari Lynx-only modules

  • Game Boy–only modules

  • X16–only modules

Implementation details

• Variable storage

• Calling convention

• Undefined behaviour

• Undocumented instruction support

• Reference for labels in generated assembly code

External links

• Example programs

• Millfork wiki

• Benchmarks

• Downloads

• Source code