108 lines
3.1 KiB
Markdown
108 lines
3.1 KiB
Markdown
# B4L Open Hardware Project Template
|
||
|
||
Welcome to the **Build4Life (B4L)** Open Hardware Project Template!
|
||
This repository provides a standardized structure for developing and sharing high-quality open hardware designs.
|
||
|
||
Use this template to kickstart your own B4L-compatible project.
|
||
|
||
---
|
||
|
||
## 📁 Folder Structure
|
||
|
||
```
|
||
hardware/ # Schematics, PCB layout, BOM, manufacturing files
|
||
mechanical/ # Mechanical designs and 3D printable enclosures
|
||
firmware/ # Microcontroller firmware
|
||
software/ # PC-side tools or GUIs
|
||
docs/ # User guides, images, datasheets
|
||
tests/ # Test plans and reports
|
||
ci/ # Continuous Integration config
|
||
tools/ # Development and debug tools
|
||
certs/ # Certification and compliance documentation
|
||
manufacturing/ # Production-level data for fab and assembly
|
||
meta/ # Project metadata and changelog
|
||
```
|
||
|
||
---
|
||
|
||
## 📂 Folder Descriptions
|
||
|
||
### `/hardware/`
|
||
Contains all electrical design files:
|
||
- `schematics/`: KiCad or EDA schematic files
|
||
- `pcb/`: PCB layout files
|
||
- `bom/`: Bill of Materials
|
||
- `manufacturing/`: Gerbers, pick-and-place, drill files
|
||
- `simulations/`: Simulation circuits (e.g. SPICE)
|
||
|
||
### `/mechanical/`
|
||
Mechanical or enclosure design:
|
||
- `enclosure/`: STL/STEP files for 3D-printable parts
|
||
- `cad/`: Editable CAD models (FreeCAD, Fusion360)
|
||
- `drawings/`: 2D drawings for fabrication or documentation
|
||
- `stl/`: Final 3D-printable export files
|
||
|
||
### `/firmware/`
|
||
Firmware source code:
|
||
- `src/`, `include/`, `lib/`: Microcontroller code and dependencies
|
||
- Example: PlatformIO, STM32Cube, Arduino, Zephyr
|
||
|
||
### `/software/`
|
||
Optional software tools, GUI, or helper scripts:
|
||
- `gui/`: Any frontend or desktop apps
|
||
- `scripts/`: CLI or backend support tools
|
||
|
||
### `/docs/`
|
||
Project documentation:
|
||
- `overview.md`, `quickstart.md`, photos, diagrams
|
||
- `datasheets/`: PDFs of important components
|
||
|
||
### `/tests/`
|
||
Hardware and firmware testing:
|
||
- `hardware/`: Test jigs, test instructions
|
||
- `firmware/`: Unit and integration test code
|
||
- `reports/`: Test results, logs, and photos
|
||
|
||
### `/ci/`
|
||
Automation and CI pipelines:
|
||
- GitHub Actions, GitLab CI, etc.
|
||
|
||
### `/tools/`
|
||
Developer tools, flashing utilities, debug helpers
|
||
|
||
### `/certs/`
|
||
Regulatory and certification documents (e.g., CE, FCC)
|
||
|
||
### `/manufacturing/`
|
||
Everything needed for production:
|
||
- `assembly/`: Instructions for assembly/test stations
|
||
- `fab/`: Files needed by PCB fab houses
|
||
|
||
### `/meta/`
|
||
Project metadata:
|
||
- `b4l_manifest.json`: Name, version, tags, license
|
||
- `authors.md`, `changelog.md`
|
||
|
||
---
|
||
|
||
## 📝 License
|
||
|
||
This template is open source. Choose a license appropriate for your project.
|
||
Recommended: [CERN-OHL-S-2.0](https://gitlab.com/ohwr/project/cernohl/) for open hardware.
|
||
|
||
---
|
||
|
||
## 🤝 Contributing
|
||
|
||
If you’re creating a new B4L-compatible project, click “Use this template” or clone this repository.
|
||
|
||
You’re encouraged to submit improvements to this template!
|
||
|
||
---
|
||
|
||
## 📡 About Build4Life
|
||
|
||
**Build4Life** is a community-driven initiative designing durable, open, and maintainable electronics.
|
||
|
||
Website: [https://buildfor.life](https://buildfor.life)
|