diff --git a/README.markdown b/README.markdown index c465b03e9736804266c6b2c318fbf3a2504ffa9c..57581b384e561b4e4484a1528ce6f9d95a94adda 100644 --- a/README.markdown +++ b/README.markdown @@ -24,7 +24,7 @@ The software that runs on the microcontroller is known as firmware and is writte # Building from source Precompiled binaries of the firmware are [available](http://microfluidics.utoronto.ca/gitlab/dstat/dstat-firmware/builds) from the automated build system (click the download button for the desired build) and can be uploaded using [avrdude](http://www.nongnu.org/avrdude/) or Atmel Studio. -The most up to date [code](http://microfluidics.utoronto.ca/gitlab/dstat/dstat-firmware/repository/archive.zip?ref=develop) can be found in the `develop` branch and must be compiled before it can be loaded onto the microcontroller. +The most up to date firmware can be found in the `develop` (or individual feature) branches. ## Build requirements @@ -45,19 +45,24 @@ The easiest way to build the firmware on Mac or Linux (Make is available in Wind This will produce the firmware binaries that will be loaded onto the microcontroller. `atxmega256a3u_104.hex` is a bootloader for upgrading firmware over USB after the initial flash (currently experimental) and `dstat-firmware.hex` or `dstat-firmware.elf` is the actual firmware. +To compile for a dstat-hardware version earlier than 1.2.3, instead do: +```` + make BOARD_VER_MICRO=0 +```` + ## Building with Make (using Docker) On Windows, the easiest way to compile the source is using make from docker (Keep in mind you can use the automated build system if you don't intend to make modifications to the firmware).: 1. Install docker from https://docs.docker.com/docker-for-windows/ 2. Use the tray icon for Docker to enable sharing on your C drive (under Shared Drives) -3. In a command prompt: `docker run —rm -w /src -v c:/Users/mdryden/src/dstat-firmware/DSTAT:/src —entrypoint make vyivanov/avr-docker` +3. In a command prompt: `docker run --rm -w /src -v c:/Users/mdryden/src/dstat-firmware/DSTAT:/src --entrypoint make vyivanov/avr-docker` Replacing `c:/Users/mdryden/src/dstat-firmware/DSTAT` with the path to wherever you cloned the source. This should compile your source files and you can upload them with avrdude or Atmel Studio. To compile for a dstat-hardware version earlier than 1.2.3, instead do: ```` - make BOARD_VER_MICRO=0 + docker run --rm -w /src -v c:/Users/mdryden/src/dstat-firmware/DSTAT:/src --entrypoint "make BOARD_VER_MICRO=0" vyivanov/avr-docker ```` # Installation