Document development environment (ikeyasu#26)

Co-authored-by: stla <[email protected]>

Author: Sturla22

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v2.3.0
+      hooks:
+          - id: check-yaml
+    - repo: https://github.com/pocc/pre-commit-hooks
+      rev: python
+      hooks:
+          - id: clang-format
+            args: [-i]
+            exclude: 'libraries/.*'

README.md

@@ -25,3 +25,43 @@ Open ayab.ino in Arduino IDE.
 Press 'verify' to check that your setup is in good shape.
 
 Press 'upload' to update your AYAB hardware with new firmware.
+
+## Development Environment
+
+To set up a working development environment follow these steps:
+
+ 1. Install the Arduino IDE version 1.0.6 into a tools directory in your $HOME directory.
+
+    ```bash
+    cd ~/tools
+    wget http://downloads.arduino.cc/arduino-1.0.6-linux64.tgz
+    tar xf arduino-1.0.6-linux64.tgz
+    ```
+    Running ./build.sh should work now.
+
+ 2. Install clang-format and gcovr
+
+    Ubuntu:
+    ```bash
+    sudo apt install clang-format gcovr
+    ```
+
+ 3. Install [pre-commit](https://pre-commit.com/) via pip and use it to install git hooks
+
+    ```bash
+    pip3 install --user pre-commit
+    pre-commit install
+    ```
+
+ 4. Optionally create a pre-push hook
+
+    Add the following snippet in a file called .git/hooks/pre-push
+    ```bash
+    #!/bin/bash
+    set -e
+
+    ./build.sh
+    make clean
+    ./test/test.sh
+    ```
+