Skip to content

Commit

Permalink
Add README for the build system module
Browse files Browse the repository at this point in the history
  • Loading branch information
julianstirling committed Jul 8, 2024
1 parent fe0ef14 commit f8f7831
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions nimble_build_system/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
The nimble build system is a python module containing custom functionality for building the nimble hardware.

This is divided into three sub-packages:

* `cad` - This containts any helper functions for building the Nimble CAD models. This does not contain the scripts for generating specific CAD models and assemblies. These are held in the `mechanical` directory of the repository.
* `orchestration` - This contains code for the Nimble project's interaction with [CadOrchestrator](https://gitlab.com/gitbuilding/cadorchestrator)
* `utils` - This contains scripts assorted utility scripts, for example for updating the json configuration files.

0 comments on commit f8f7831

Please sign in to comment.