1
0
mirror of https://github.com/KarolS/millfork.git synced 2026-04-27 01:19:37 +00:00

Documentation overhaul

This commit is contained in:
Karol Stasiak
2019-07-15 13:52:05 +02:00
parent f3dcfc78ba
commit 52c5a10e6e
47 changed files with 157 additions and 136 deletions
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
### A note about Apple II
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
### A note about BBC Micro
+12 -9
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
# Command-line options
@@ -15,16 +15,19 @@
* `-o <file>` Output filename, without extension.
Extension will be added automatically,
`.prg` for Commodore (including LUnix/LNG),
`.a2` for Apple,
`.crt` for Commodore cartridges,
`.xex` for Atari computers,
`.bin` for Atari VCS,
`.nes` for NES,
no extension for BBC micro program file,
`.inf` for BBC Micro metadata,
`.d88` for PC-88 disk images,
`.com` for CP/M executables,
`.a2` for Apple,
`.dsk` for PC-88 disk images,
`.tap` for ZX-Spectrum tape images,
`.rom` for MSX cartridge images,
`.tap` for ZX-Spectrum tape images.
`.com` for CP/M executables,
`.nes` for NES/Famicom,
`.bin` for Atari 2600,
no extension for BBC micro program file,
`.inf` for BBC Micro file metadata,
`.asm` for assembly output,
`.lbl`, `.nl`, `.fns`, or `.sym` for label file.
* `-s` Generate also the assembly output. It is not compatible with any assembler, but it serves purely informational purpose. The file has the same nam as the output file and the extension is `.asm`.
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
### A note about Commodore 64
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
### A note about Amstrad CPC
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
## Adding a custom platform
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
# Famicom/NES programming guide
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
# Game Boy programming guide
+8 -15
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
# Getting started
@@ -21,6 +21,12 @@ Compile it using the following commandline:
java -jar millfork.jar hello_world.mfk -o hello_world -t c64
```
or if you're using a Windows native build:
```
millfork hello_world.mfk -o hello_world -t c64
```
Run the output executable (here using the VICE emulator):
```
@@ -31,20 +37,7 @@ x64 hello_world.prg
The following options are obligatory when compiling your sources:
* `-o FILENAME` specifies the base name for your output file, an appropriate file extension will be appended:
`prg` for Commodore;
`crt` for Commodore cartridges;
`xex` for Atari computers;
`a2` for Apple;
`dsk` for PC-88;
`tap` for ZX Spectrum;
`rom` for MSX cartridges;
`com` for CP/M;
`nes` for Famicom;
`bin` for Atari 2600;
`inf` for BBC file metadata;
`asm` for assembly output;
`lbl`, `nl`, `fns`, or `sym` for label file
* `-o FILENAME` specifies the base name for your output file, an appropriate file extension will be appended.
* `-t PLATFORM` specifies the target platform.
Each platform is defined in an `.ini` file in the include directory.
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
### A note about LUnix
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
### ROM vs RAM targets
+1 -1
View File
@@ -1,4 +1,4 @@
[< back to index](../index.md)
[< back to index](../README.md)
# Target platforms