millfork/README.md

![](logo_transparent.png)

# Millfork

A middle-level programming language targeting 6502-based and Z80-based microcomputers. 

For binary releases, see: https://github.com/KarolS/millfork/releases
(latest: 0.3.0, doesn't support Z80 yet)

## Features

* multiple targets:

    * Commodore 64 (the primary target)
    
    * Commodore 64 with SuperCPU (experimental, incomplete and very buggy)
    
    * Commodore 16 and Plus/4
    
    * Commodore 128
    
    * Commodore 64/128 running LUnix/LNG 0.21 (experimental)
    
    * Commodore PET
    
    * Commodore Vic-20 (stock or with RAM extensions)
    
    * Famicom/NES (the second most important target)
    
    * Atari 2600 (experimental)
    
    * Atari 8-bit computers
    
    * BBC Micro
    
    * Apple II+/IIe/Enhanced IIe
    
    * ZX Spectrum 48k
    
    * NEC PC-88
    
    * CP/M

* inline assembly

* simple macros

* pay only for what you use: not a single byte of memory is used unless for code or explicitly declared variables

* simple memory model that avoids using the stack

* multi-pass optimizer (that will even optimize your hand-written assembly if you ask it to)

## Licensing

The compiler is distributed under GPLv3 (see [LICENSE](LICENSE)).

The standard include files (located in the `include` directory) are distributed under a more permissive Zlib license (see [include/LICENSE](include/LICENSE)).
Therefore, no attribution is needed if you are developing and distributing Millfork programs.

## More info

* [Documentation](docs/index.md)

* [Example programs](examples/README.md)

## Planned features

* stdlib improvements

* more 6502 targets: Oric computers, PC-Engine/Turbografx-16, Atari Lynx

* more Z80 targets: Armstrad CPC, MSX, TI-83, Sega Master System
 
* better support for 65816, Intel 8080, Sharp LR35902 and eZ80

* support for CP/M, Gameboy, SuperFamicom/SNES and Apple IIgs
Logo 2018-01-21 00:24:56 +00:00			`![](logo_transparent.png)`

Empty repo initialization 2017-12-06 21:00:04 +00:00			`# Millfork`

Documentation updates 2018-07-24 22:04:00 +00:00			`A middle-level programming language targeting 6502-based and Z80-based microcomputers.`
Initial code upload 2017-12-06 23:23:30 +00:00
Documentation updates 2018-07-24 22:04:00 +00:00			`For binary releases, see: https://github.com/KarolS/millfork/releases`
			`(latest: 0.3.0, doesn't support Z80 yet)`
Version 0.1 2018-01-24 16:47:20 +00:00
Empty repo initialization 2017-12-06 21:00:04 +00:00			`## Features`

			`* multiple targets:`

			`* Commodore 64 (the primary target)`

Preliminary support for 65816, 65CE02 and HuC6280 2018-03-03 00:21:57 +00:00			`* Commodore 64 with SuperCPU (experimental, incomplete and very buggy)`

Empty repo initialization 2017-12-06 21:00:04 +00:00			`* Commodore 16 and Plus/4`

			`* Commodore 128`

Preliminary LUnix support 2018-06-08 22:18:21 +00:00			`* Commodore 64/128 running LUnix/LNG 0.21 (experimental)`

Empty repo initialization 2017-12-06 21:00:04 +00:00			`* Commodore PET`

			`* Commodore Vic-20 (stock or with RAM extensions)`

Version 0.2 2018-03-17 17:21:50 +00:00			`* Famicom/NES (the second most important target)`
Famicom support 2018-03-15 22:46:16 +00:00
Preliminary Atari 2600 support 2018-04-03 21:13:57 +00:00			`* Atari 2600 (experimental)`

Empty repo initialization 2017-12-06 21:00:04 +00:00			`* Atari 8-bit computers`
Preliminary Apple II support 2018-01-23 12:37:03 +00:00
Documentation improvements 2018-04-02 22:21:26 +00:00			`* BBC Micro`

Preliminary Apple II support 2018-01-23 12:37:03 +00:00			`* Apple II+/IIe/Enhanced IIe`
Documentation updates 2018-07-24 22:04:00 +00:00
			`* ZX Spectrum 48k`

			`* NEC PC-88`
Preliminary CP/M support 2018-07-30 23:02:55 +00:00
			`* CP/M`
Empty repo initialization 2017-12-06 21:00:04 +00:00
			`* inline assembly`

Version 0.2 2018-03-17 17:21:50 +00:00			`* simple macros`

Empty repo initialization 2017-12-06 21:00:04 +00:00			`* pay only for what you use: not a single byte of memory is used unless for code or explicitly declared variables`

			`* simple memory model that avoids using the stack`

			`* multi-pass optimizer (that will even optimize your hand-written assembly if you ask it to)`

Less restrictive licensing for the standard library 2018-06-22 16:16:10 +00:00			`## Licensing`

			`The compiler is distributed under GPLv3 (see [LICENSE](LICENSE)).`

			The standard include files (located in the `include` directory) are distributed under a more permissive Zlib license (see [include/LICENSE](include/LICENSE)).
			`Therefore, no attribution is needed if you are developing and distributing Millfork programs.`

Readme update 2018-01-21 20:55:44 +00:00			`## More info`

Rename documentation files 2018-03-28 17:31:10 +00:00			`* [Documentation](docs/index.md)`
Readme update 2018-01-21 20:55:44 +00:00
Documentation improvements 2018-04-02 22:21:26 +00:00			`* [Example programs](examples/README.md)`
Readme update 2018-01-21 20:55:44 +00:00
Empty repo initialization 2017-12-06 21:00:04 +00:00			`## Planned features`

Documentation updates 2018-07-24 22:04:00 +00:00			`* stdlib improvements`
Really early and very incomplete PC-88 support 2018-07-01 22:31:47 +00:00
			`* more 6502 targets: Oric computers, PC-Engine/Turbografx-16, Atari Lynx`
Documentation updates 2018-07-24 22:04:00 +00:00
			`* more Z80 targets: Armstrad CPC, MSX, TI-83, Sega Master System`
Preliminary support for 65816, 65CE02 and HuC6280 2018-03-03 00:21:57 +00:00
Update README and CHANGELOG 2018-07-27 17:15:57 +00:00			`* better support for 65816, Intel 8080, Sharp LR35902 and eZ80`
Documentation updates 2018-07-24 22:04:00 +00:00
			`* support for CP/M, Gameboy, SuperFamicom/SNES and Apple IIgs`