From fdf7afd9d9aea644a46ed225c582837b3dd3fd1a Mon Sep 17 00:00:00 2001 From: Filip Ayazi Date: Thu, 1 Jul 2021 21:37:42 +0000 Subject: [PATCH] Make current status more clear in README --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c505242..aacb3de 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ -# Firmware code for the sangaboard +# Firmware for the Sangaboard and similar motor controllers -*This firmware is Work in Progress and while it should now support all features of the original, many features are untested.* +## This firmware is a Work in Progress, do NOT use for production builds +Many features of this firmware are untested and it changes behaviour of the pysangaboard module, breaking fast autofocus in OFM software (see #1, !1). If you want a reliable device use [the original firmware](https://gitlab.com/bath_open_instrumentation_group/sangaboard/-/blob/master/arduino_code). + +If you like living on the edge and decide to use this firmware, please report any issues you run into to this repo. + +## About Firmware for the control board of OpenFlexure Microscope. This is a refactor of the [original arduino code](https://gitlab.com/bath_open_instrumentation_group/sangaboard/-/blob/master/arduino_code) with some improvements to the infrastructure and features. ## Notable changes @@ -47,4 +52,4 @@ for sangaboard v0.3 replace `nano` with `leonardo` in the above commands (untest - [x] Support other platforms - [ ] Clean up - [ ] Improve handling of unused modules/libraries - - [ ] Lower RAM use \ No newline at end of file + - [ ] Lower RAM use