add Arduino build + English manual

hiveeyes / hanimandl

HaniMandl ist ein halbautomatischer Honig-Abfüll-Roboter.

https://hanimandl.readthedocs.io/

GNU General Public License v3.0

38 stars 29 forks source link

add Arduino build + English manual #62

Open RobTillaart opened 2 weeks ago

RobTillaart commented 2 weeks ago

English manual by google translate and quickly reviewed by me. Needs verification.

RobTillaart commented 2 weeks ago

Relates to

RobTillaart commented 2 weeks ago

@amotl When merging best use the SQUASH option so all my commits will merge into one.

amotl commented 2 weeks ago

Dear Rob,

wow, that was quick, and your patch is really extensive. Thank you so much!

With kind regards, Andreas.

RobTillaart commented 2 weeks ago

@amotl You're welcome! The English handbook looks OK too (imho), it is processed without problems by readthedocs.yml.

amotl commented 2 weeks ago

I just ran through a quick review, yielding some comments shared above, and will be happy to try addressing all details on my own behalf before merging. When doing it, I will also squash your commits as suggested. Thanks again!

RobTillaart commented 2 weeks ago

@amotl

Two things you could start using:

label the open issues (bug, enhancement, question, etc) to prioritize them.
use a const char version[12] = "X.Y.Z" in the application, to be displayed on the opening screen
- use the GitHub Releases to formalize this version number.
- people can easily refer to the version as they see it at startup.

RobTillaart commented 2 weeks ago

You might want to have this badge in the readme too?

[![GitHub issues](https://img.shields.io/github/issues/hiveeyes/hanimandl.svg)](https://github.com/hiveeyes/hanimandl/issues)