From f870a0c3811878d685f3c8a750af25d39a3e7df2 Mon Sep 17 00:00:00 2001 From: Karol Stasiak Date: Sun, 21 Jan 2018 21:55:44 +0100 Subject: [PATCH] Readme update --- README.md | 8 ++++++-- examples/README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 examples/README.md diff --git a/README.md b/README.md index 3ff05cc2..83d3259d 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,14 @@ Distributed under GPLv3 (see [LICENSE](LICENSE)) * multi-pass optimizer (that will even optimize your hand-written assembly if you ask it to) +## More info + +* [Documentation](doc/README.md) + +* [Example programs](examples/README.md) + ## Planned features * multi-part programs * more targets: Famicon/NES, BBC Micro/Electron, Oric computers, Apple II, PC-Engine/Turbografx-16, Atari Lynx - -* a better optimizer \ No newline at end of file diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..7e12ded7 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,26 @@ +# Examples + +## Cross-platform examples + +* [Hello world](hello_world/hello_world.mfk) (C64/C16/PET/VIC-20/Atari) – simple text output + +## Commodore 64 examples + +### Console I/O examples + +* [Echo](c64/echo.mfk) – simple text input and output + +* [Calculator](c64/calculator.mfk) – simple numeric input and output + +* [Text encodings](c64/text_encodings.mfk) – examples of text encoding features + +* [Panic](c64/panic_test.mfk) – how panic works on C64, showing the address of where it happened + +### Graphical examples: + +* [Rasterbar](c64/rasterbar.mfk) – simple rasterbar effect + +* [Softscrolling](c64/softscroll.mfk) – soft-scrolling a single line of text + +* [Galencia starfield](c64/galencia.mfk) – a port of the starfield effect from the game *Galencia* +