From 7851bb2d10bbcfff005d407b4f6cd696f9215734 Mon Sep 17 00:00:00 2001 From: Doug Brown Date: Sat, 3 Jun 2023 20:08:29 -0700 Subject: [PATCH] Update README with build instructions This README contains an overall summary of the entire project, but it was missing build instructions for the firmware. Add them now that cmake is all set up. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 5ead461..b2abe4c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,19 @@ The project is spread over a few repositories. Some of them have a wiki. | CAD for programmer, along with 2 MB and 8 MB SIMM PCBs | https://github.com/dougg3/mac-rom-simm-programmer.cad | none | | Mac ROM patcher | https://github.com/jpluimers/macrompatcher/ (from https://code.google.com/p/macrompatcher) | none | +# Firmware compilation instructions + +As mentioned earlier, this is an AVR project that is currently optimized for avr-gcc 4.8.2. It can be built using either CMake or Eclipse with the [AVR Eclipse plugin](https://avr-eclipse.sourceforge.net/wiki/index.php/The_AVR_Eclipse_Plugin). To build with CMake: + +``` +mkdir build +cd build +cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-avr.cmake .. +make +``` + +This will result in a generated SIMMProgrammer.bin file which can be programmed to the board using the [Windows/Mac/Linux software](https://github.com/dougg3/mac-rom-simm-programmer.software). + # Videos ## ROM SIMM