millfork/docs/README.md

# Documentation index

* [Home page](index.md)

## Compiler usage

* [Getting started](api/getting-started.md)

* [Command-line option reference](api/command-line.md)

* [Target platform reference](api/target-platforms.md)

* [Defining a custom platform](api/custom-platform.md)

## Language reference

* [Preprocessor](lang/preprocessor.md)

* [Modules](lang/modules.md)

* [Syntax](lang/syntax.md)

* [Types](lang/types.md)

* [Literals](lang/literals.md)

* [Predefined constants](lang/predefined_constants.md)

* [List of text encodings and escape sequences](lang/text.md)

* [Operators reference](lang/operators.md)

* [Functions](lang/functions.md)

* [Inline 6502 assembly syntax](lang/assembly.md)

* [Inline 8080/LR35902/Z80 assembly syntax](lang/assemblyz80.md)

* [Inline 6809 assembly syntax](lang/assembly6809.md)

* [Important guidelines regarding reentrancy](lang/reentrancy.md)

* [List of keywords](lang/keywords.md)

## Library reference

* [`stdlib` module](stdlib/stdlib.md)

* [`string`, `scrstring` and `pstring` modules](stdlib/string.md)

* [`stdio` module](stdlib/stdio.md)

* Reading input devices:

    * [`joy` module](stdlib/joy.md)

    * [`keyboard` module](stdlib/keyboard.md)

    * [`mouse` module](stdlib/mouse.md)

* [`encconv` module](stdlib/encconv.md)

* [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 Boy–only modules](stdlib/gb.md)
    
    * [X16–only modules](stdlib/x16.md)
    
## Guides

* [Differences from C](various/cdiff.md) 

* [Differences from other assemblers](various/asmdiff.md) 

* [Optimization guide](various/optimization.md) 

## Implementation details

* [Variable storage](abi/variable-storage.md)

* [Calling convention](abi/calling-convention.md)

* [Undefined behaviour](abi/undefined-behaviour.md)

* [Undocumented instruction support](abi/undocumented.md)

* [Reference for labels in generated assembly code](abi/generated-labels.md)

## 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)
-												Documentation overhaul

											
										
										
											2019-07-15 11:52:05 +00:00
+								# Documentation index
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
-												Documentation overhaul

											
										
										
											2019-07-15 11:52:05 +00:00
+								* [Home page](index.md)
-												Documentation improvements

											
										
										
											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)
-												Documentation updates

											
										
										
											2018-07-24 22:04:00 +00:00
+								* [Defining a custom platform](api/custom-platform.md)
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
+								## Language reference
-												Documentation updates

											
										
										
											2018-07-24 22:04:00 +00:00
+								* [Preprocessor](lang/preprocessor.md)
-												Module templates

											
										
										
											2020-06-03 21:13:17 +00:00
+								* [Modules](lang/modules.md)
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
+								* [Syntax](lang/syntax.md)
 								* [Types](lang/types.md)
-												Text literals in expressions, escape sequences, and more

											
										
										
											2018-07-27 22:58:20 +00:00
+								* [Literals](lang/literals.md)
-												Added encconv module.

											
										
										
											2019-09-03 23:14:14 +00:00
+								* [Predefined constants](lang/predefined_constants.md)
-												Text literals in expressions, escape sequences, and more

											
										
										
											2018-07-27 22:58:20 +00:00
+								* [List of text encodings and escape sequences](lang/text.md)
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
+								* [Operators reference](lang/operators.md)
 								* [Functions](lang/functions.md)
-												Documentation updates

											
										
										
											2018-07-24 22:04:00 +00:00
+								* [Inline 6502 assembly syntax](lang/assembly.md)
-												Almost full LR35902 opcode space coverage

											
										
										
											2018-07-27 17:07:12 +00:00
+								* [Inline 8080/LR35902/Z80 assembly syntax](lang/assemblyz80.md)
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
-												Update and reorganize documentation

											
										
										
											2020-03-31 17:07:35 +00:00
+								* [Inline 6809 assembly syntax](lang/assembly6809.md)
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
+								* [Important guidelines regarding reentrancy](lang/reentrancy.md)
-												Document keywords and handle them better

											
										
										
											2019-10-07 23:33:55 +00:00
+								* [List of keywords](lang/keywords.md)
-												Documentation updates

											
										
										
											2018-07-24 22:04:00 +00:00
+								## Library reference
 								* [`stdlib` module](stdlib/stdlib.md)
-												Add pstring module

											
										
										
											2020-04-05 22:44:20 +00:00
+								* [`string`, `scrstring` and `pstring` modules](stdlib/string.md)
-												Library improvements:
– random module
– ensure_mixedcase() function

											
										
										
											2018-12-30 17:59:32 +00:00
-												Documentation fixes

											
										
										
											2019-06-05 09:46:06 +00:00
+								* [`stdio` module](stdlib/stdio.md)
-												Update and reorganize documentation

											
										
										
											2020-03-31 17:07:35 +00:00
+								* Reading input devices:
-												Documentation updates

											
										
										
											2018-07-24 22:04:00 +00:00
-												Update and reorganize documentation

											
										
										
											2020-03-31 17:07:35 +00:00
+								    * [`joy` module](stdlib/joy.md)
-												Documentation updates

											
										
										
											2018-07-24 22:04:00 +00:00
-												Update and reorganize documentation

											
										
										
											2020-03-31 17:07:35 +00:00
+								    * [`keyboard` module](stdlib/keyboard.md)
-												C64: File I/O support

											
										
										
											2019-01-05 00:19:14 +00:00
-												Update and reorganize documentation

											
										
										
											2020-03-31 17:07:35 +00:00
+								    * [`mouse` module](stdlib/mouse.md)
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
-												Update and reorganize documentation

											
										
										
											2020-03-31 17:07:35 +00:00
+								* [`encconv` module](stdlib/encconv.md)
-												Update documentation

											
										
										
											2019-03-18 22:15:28 +00:00
-												Update and reorganize documentation

											
										
										
											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 Boy–only modules](stdlib/gb.md)
 								    * [X16–only modules](stdlib/x16.md)
-												Add guides to documentation

											
										
										
											2020-07-24 17:13:46 +00:00
 								## Guides
 								* [Differences from C](various/cdiff.md)
 								* [Differences from other assemblers](various/asmdiff.md)
 								* [Optimization guide](various/optimization.md)
-												Commander X16 improvements

											
										
										
											2019-09-16 20:55:08 +00:00
-												Documentation improvements

											
										
										
											2018-04-02 22:21:26 +00:00
+								## Implementation details
 								* [Variable storage](abi/variable-storage.md)
-												Documentation updates

											
										
										
											2018-07-24 22:04:00 +00:00
+								* [Calling convention](abi/calling-convention.md)
-												Documentation improvements

											
										
										
											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)
-												Documentation overhaul

											
										
										
											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)