Merge commit 'refs/pull/1271/head' of https://github.com/BitBoxSwiss/bitbox02-firmware

Author: benma

BUILD.md

@@ -36,12 +36,28 @@ make dockerinit
 make dockerdev
 ```
 
+If you do not want to build the docker image locally, or are not working on it, it may be more straightforward to
+pull the image from docker instead of building it. This should be a bit faster and there should not be any issues with
+`make dockerdev` expecting specific version of the image.
+
+```sh
+make dockerpull
+make dockerdev
+```
+
+
 The docker container will not allow you to access the hosts USB devices by default which means that
 it is necessary to flash the device in a terminal not running in docker.
 
 > [!NOTE]
 > Current development container is defined in the file `.containerversion`
 
+The docker container mounts the repo it was launched from, so you can freely edit your fork in your preferred IDE and
+the changes will be reflected in the docker container.
+
+**It is highly recommended you develop using this docker container as not all of local setup is completely up to date
+with every Operating system.**
+
 ### Install development environment on macOS
 
 Make sure you have [Homebrew](https://brew.sh) installed.

py/README.md

@@ -4,3 +4,6 @@ To use the scripts (`send_message.py`, `load_firmware.py` for example) go into t
 directory and run `pip3 install .`.
 
 If you plan to work on the scripts run `pip3 install -e .` instead.
+
+It is highly recommended that you use the dockerized setup while developing, guide for setting it up
+can be found in [BUILD.md](../BUILD.md).

py/bitbox02/README.md

@@ -15,3 +15,16 @@ bitbox02.
 In this folder is the Python API for communicating with the BitBox02 device.
 
 The folder `generated` contains files generated by `python-protobuf`. Regenerate with `make`.
+
+
+### Development environment
+
+It is highly recommended that you use the dockerized setup while developing, guide for setting it up
+can be found in [BUILD.md](../../BUILD.md).
+
+If you intended to develop instead on your local environment be vary that some development procedures
+such as regenerating files have their libraries NOT in requirements.txt as they are not necessary for the bitbox02 
+Python package.
+
+It is highly advisable to use same version that is used in the [Dockerfile](../../Dockerfile) that is used in dockerized
+setup.