From 99b6faf7e3b785ddaf9d2da6010596295e478445 Mon Sep 17 00:00:00 2001 From: Will Angenent Date: Sun, 27 May 2018 21:46:14 +0100 Subject: [PATCH] README tidy up --- README.md | 46 +++++++++++++++++++++------------------------- 1 file changed, 21 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index f170f54..8f327ee 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ -# Apple //e emulator in go +# Apple // emulator in go -Ebiten based apple //e emulator written in go. +An Apple //e emulator written in Go using [ebiten](https://github.com/hajimehoshi/ebiten). ## Features * MOS 6502 CPU -* keyboard +* Keyboard * 40 column text mode -* low resolution color graphics -* high resolution monochrome graphics -* upper memory bank switching: $d000 page and ROM/RAM switching -* main memory page1/page2 switching in text, lores and hires -* speaker audio +* Low resolution color graphics +* High resolution monochrome graphics +* Upper memory bank switching: $d000 page and ROM/RAM +* Main memory page1/page2 switching in text, lores and hires +* Disk image reading & writing +* Speaker audio ## Installation @@ -32,13 +33,19 @@ Download `apple2e.rom` from ./apple2 my_disk_image.dsk ./apple2 -drive-head-click my_disk_image.dsk +## Keyboard shortcuts + +* ctrl-alt-R reset +* ctrl-alt-M mute +* ctrl-alt-C caps lock + ## Running the tests -### Setting up the tests +### Setup -Some disk images are used for the tests +The tests use DOS and Prodos disk images. Download them from -* dos33.dsk from e.g. [mirrors.apple2.org.za](https://mirrors.apple2.org.za/ftp.apple.asimov.net/images/masters/DOS33_blank_with_integer_basic.DSK) -* prodos19.dsk from e.g. [mirrors.apple2.org.za](https://mirrors.apple2.org.za/ftp.apple.asimov.net/images/masters/prodos/ProDOS_1_9.dsk) +* dos33.dsk from [mirrors.apple2.org.za](https://mirrors.apple2.org.za/ftp.apple.asimov.net/images/masters/DOS33_blank_with_integer_basic.DSK) +* prodos19.dsk from [mirrors.apple2.org.za](https://mirrors.apple2.org.za/ftp.apple.asimov.net/images/masters/prodos/ProDOS_1_9.dsk) ### Running the tests @@ -47,26 +54,15 @@ Some disk images are used for the tests The CPU tests make use of [Klaus2m5's](https://github.com/Klaus2m5/6502_65C02_functional_tests) excellent 6502 functional tests. -## Known working images +## Known working disk images * DOS 3.3 * Prodos 1.9 * Lemonade stand * Montezuma's Revenge -## Keyboard shortcuts - -* ctrl-alt-R reset -* ctrl-alt-M mute -* ctrl-alt-C capslock - ## Remaining work * 80 column card * 48k aux memory * double hires -* paddles - -## Known issues - -1. On MacOS, the initial beep is sometimes split into two little beeps. This appears to be an ebiten issue. -2. On MacOS, shutting down sometimes takes 30 seconds or so +* joystick \ No newline at end of file