Template
grabowski
421b4202cc
Layout, proplan.toml, README/CHANGELOG, placeholder product image, .gitignore, KiBot/release/docgen workflows and TEMPLATE.md. Source of truth: contrib/product-template in B4L/proplan (cargo test --test product_template checks it as Gitea 1.27 creates a repository from it).
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
# $REPO_NAME
|
|
|
|
$REPO_DESCRIPTION
|
|
|
|
Created from [B4L/product-template](https://git.b4l.co.th/B4L/product-template).
|
|
TEMPLATE.md explains the layout, the rules and `proplan.toml`.
|
|
|
|
| Folder | What goes there |
|
|
|---|---|
|
|
| `assets/` | the product image (`assets/product.png`, shown by proplan), renders |
|
|
| `hardware/$REPO_NAME/` | the KiCad project of the board |
|
|
| `hardware/lib/` | symbols, footprints and 3D models shared by the boards |
|
|
| `firmware/` | MCU code, one folder per target; `firmware/lib/` for shared drivers |
|
|
| `external/` | third-party code as git submodules |
|
|
| `software/` | host tools and apps |
|
|
| `mech/` | FreeCAD sources and STEP exports |
|
|
| `sim/` | LTspice/ngspice models, calculation scripts and notebooks |
|
|
| `test/` | bench results per prototype stage (`test/v0.1/`) |
|
|
| `docs/` | documentation; `docs/datasheets/` for vendor PDFs, `docs/tex/` for LaTeX |
|
|
|
|
## Prototype stages
|
|
|
|
Each prototype is a git tag (`v0.1`, `v0.2`, ...). CI builds gerbers, BOM and
|
|
schematic PDFs for the tag and attaches them to its release; CHANGELOG.md says
|
|
what each stage changes. In proplan the prototype stage links the tag.
|