diff --git a/README.md b/README.md index e10381e..0703e2c 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,13 @@ a lot easier. There are two files that you'll need: - apple2e.rom -- a 32k dump of the entire Apple //e ROM - disk.rom -- a 256 byte dump of the DiskII controller ROM (16-sector P5) +* apple2e.rom -- a 32k dump of the entire Apple //e ROM +* disk.rom -- a 256 byte dump of the DiskII controller ROM (16-sector P5) The MD5 sums of those two files are: - 003a780b461c96ae3e72861ed0f4d3d9 apple2e.rom - 2020aa1413ff77fe29353f3ee72dc295 disk.rom +* 003a780b461c96ae3e72861ed0f4d3d9 apple2e.rom +* 2020aa1413ff77fe29353f3ee72dc295 disk.rom From those, the appropriate headers will be automatically generated by "make roms" (or any other target that relies on the ROMs). @@ -46,13 +46,13 @@ While this isn't the purpose of the emulator, it is functional, and is my first test target for most of the work. With MacOS 10.11.6 and Homebrew, you can build and run it like this: - $ make opencv - $ ./aiie-opencv /path/to/disk.dsk +``` $ make opencv + $ ./aiie-opencv /path/to/disk.dsk``` As the name implies, this requires that OpenCV is installed and in /usr/local/lib. I've done that with Homebrew like this - $ brew install opencv +``` $ brew install opencv``` "Why OpenCV?" you might ask. Well, it's just because I had code from another project lying around that directly manipulated OpenCV bitmap @@ -69,22 +69,22 @@ together the MMU, virtual keyboard, and virtual display. Then there are the physical interfaces, which aren't as well organized. They exist as globals in globals.cpp: - FileManager *g_filemanager = NULL; +``` FileManager *g_filemanager = NULL; PhysicalDisplay *g_display = NULL; PhysicalKeyboard *g_keyboard = NULL; PhysicalSpeaker *g_speaker = NULL; - PhysicalPaddles *g_paddles = NULL; + PhysicalPaddles *g_paddles = NULL;``` There are the two globals that point to the VM and the virtual CPU: - Cpu *g_cpu = NULL; - VM *g_vm = NULL; +``` Cpu *g_cpu = NULL; + VM *g_vm = NULL;``` And there are two global configuration values that probably belong in some sort of Prefs class: - int16_t g_volume; - uint8_t g_displayType; +``` int16_t g_volume; + uint8_t g_displayType;``` CPU