Skip to content

Commit 7fa3184

Browse files
committed
chore: revise readme
1 parent 498ce24 commit 7fa3184

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ make build
3030

3131
Follow setup instructions [here](https://docs.zephyrproject.org/latest/develop/getting_started/index.html).
3232

33-
### Contributing
33+
## Contributing
3434
Currently, we protect main branch by PR approval and an automated test of our common libraries.
3535
More automated tests will follow.
3636

3737

38-
### ZephyrRTOS
38+
## ZephyrRTOS
3939
We have some zephyr rtos projects under zephyr_projects. To build/develop them you will need to install zephyr: https://docs.zephyrproject.org/latest/develop/getting_started/index.html
4040

41-
### Arduino
41+
## Arduino
4242
We have some arduino projects, under arduino_firmware.
4343

4444
### Common Libraries
@@ -47,7 +47,7 @@ We have an example here, that shows the general workflow for creating a common l
4747

4848
1. [Low pass FIR filter](common_libraries/low_pass_fir_filter/README.md)
4949

50-
### Testing
50+
## Testing
5151
We use Catch2 for testing cpp and c code. It's an easy to use, and easy to integrate tool for cpp unit tests.
5252
Ideally, all our code has test coverage. Test driven development (TDD) is a powerful process where if done perfectly, you never push a bug that would impact system operations, because your tests would cover every needed operation of the system.
5353

@@ -57,8 +57,14 @@ Catch2 docs are in it's readme: https://github.com/catchorg/Catch2?tab=readme-ov
5757

5858
A good book on TDD is Test Driven Development for Embedded Systems: https://pragprog.com/titles/jgade/test-driven-development-for-embedded-c/
5959

60+
For example, to test the common libraries, do:
61+
```bash
62+
cd common_libraries/
63+
make test
64+
```
65+
6066
### ROS2 Tests
6167
We have some ros2 code in here, specifically for testing firmware. Might be moved to RoverFlake2 in the future.
6268

63-
### End Notes
69+
## End Notes
6470
The filestructure is currently based around development enviroments, we may change this to project based structure in the future.

0 commit comments

Comments
 (0)