build instructions: remove title case
- Install the pre-built [protobuf python binary](https://github.com/protocolbuffers/protobuf/releases)
- Then install the included [Python Protocol Buffers](https://github.com/protocolbuffers/protobuf/tree/master/python#installation) runtime library
-
## Reporting issues
<!-- TODO: Write section on reporting issues -->
For security related issues please see [SECURITY.md](SECURITY.md).
-## Development Environment
-
+## Development environment
### Install development environment as a Docker container
@@ -121,7 +119,7 @@ make docs
To view the results, open `build/docs/html/index.html` in a web browser.
-### BitBox02 Python Library
+### BitBox02 Python library
There is a Python api library in `py/bitbox02`.
@@ -135,7 +133,7 @@ To kick off some api calls:
./py/send_message.py
```
-### Unit Tests
+### Unit tests
We are using CMocka (https://cmocka.org/) for unit tests. To run the tests, the CMocka library
needs to be installed on your system.
@@ -181,21 +179,21 @@ make coverage # or make -C build-build coverage
make -C build-build coverage-lcovr
```
-### Device Tests
+### Device tests
If you have a developer device at hand you can run device tests on it. Device tests help to verify functionality on an actual device.
Feedback can be provided via the screen or via USB. They are especially useful to test low-level, driver-specific features.
Device tests replace the source file where the main function resides, but otherwise have access to all firmware functions.
-#### Code and Build Structure
+#### Code and build structure
The python scripts for setting up and running the test can be found under `test/device-test`. Firmware test code can be found
under `test/device-test/src`. `test/device-test/src/common` contains common C code functions that many test cases might need.
The object and binary files are built into `test/device-test/build`.
-#### How to Set Up a Test
+#### How to set up a test
The `test/device-test/setup_test.py` script assists you in building the binary with a given test case, flashing the device
with the resulting `device-test.bin` that gets built into `test/device-test/build/bin` and resetting the device so that the test is started.
@@ -208,7 +206,7 @@ You can run `setup_test.py` as follows:
If you run it successfully, the device should print `Integration test` on the screen.
-#### How to Write a Test
+#### How to write a test
The test becomes more interesting as we add the ability to function in a python script.
Here is an example for a python test:
