From 1454c983e004945262e43ee12485b48dd72a2dbf Mon Sep 17 00:00:00 2001
From: Gregor Riepl <onitake@gmail.com>
Date: Mon, 11 Jan 2021 00:30:50 +0100
Subject: [PATCH] Added build instructions for poweriface firmware

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 08badbd..f85c020 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,21 @@ on its GPIO header.
 See (CAN Hat)[https://github.com/onitake/canhat] for
 more information.
 
+## Firmware
+
+Some of the modules require firmware. There is a makefile in
+each module to build and flash it to its microcontroller.
+
+Before building, you need to check out the CAN driver
+source code, which is referenced as a Git submodule.
+
+Run the following commands in the checked out repository:
+
+```shell
+git submodule init
+git submodule update
+```
+
 ## Modules
 
 The Matemat components are highly modular. Individual
@@ -62,6 +77,21 @@ messages on changes.
 
 Interface between CAN bus and power board.
 
+This module requires firmware. Switch into the firmware
+directory `poweriface/firmware/` and run
+
+```shell
+make
+```
+
+To flash the firmware, attach a programmer to the ISP
+header on the PCB, then run:
+
+
+```shell
+make flash
+```
+
 ### sensor
 
 Environment sensor interface.