104 lines
3.2 KiB
Markdown
104 lines
3.2 KiB
Markdown
# B4L Open Hardware Project Template
|
|
|
|
Welcome to the **Build4Life (B4L)** Open Hardware Project Template!
|
|
This repository defines a standard structure for building open-source hardware projects with high transparency, maintainability, and manufacturability.
|
|
|
|
Use this as a base for your own project or as a collaborative standard for contributions.
|
|
|
|
---
|
|
|
|
## 📁 Folder Structure
|
|
|
|
```
|
|
hardware/ # Schematics, PCB, component models, libraries
|
|
mechanical/ # Enclosures and mechanical CAD
|
|
firmware/ # Embedded firmware
|
|
software/ # PC-side software and tools
|
|
docs/ # Documentation and datasheets
|
|
tests/ # Test plans, logs, reports
|
|
ci/ # Continuous Integration configuration
|
|
tools/ # Debug and development utilities
|
|
certs/ # Certification/compliance files
|
|
manufacturing/ # Production and assembly resources
|
|
meta/ # Project changelog and metadata
|
|
```
|
|
|
|
---
|
|
|
|
## 📂 Folder Descriptions
|
|
|
|
### `/hardware/`
|
|
- `schematics/`: Electrical schematics in any EDA tool
|
|
- `pcb/`: PCB layout files
|
|
- `bom/`: Bill of Materials (CSV, XLSX)
|
|
- `manufacturing/`: Gerbers, pick-and-place, drill data
|
|
- `simulations/`: SPICE or other circuit simulations
|
|
- `component-models/`: 3D models for electronic components
|
|
- `libraries/`: Custom symbols, footprints, models
|
|
|
|
### `/mechanical/`
|
|
- `enclosure/`: 3D-printable housing or case designs
|
|
- `cad/`: Editable CAD models
|
|
- `stl/`: Printable STL files
|
|
- `drawings/`: 2D mechanical drawings for CNC or documentation
|
|
|
|
### `/firmware/`
|
|
- `src/`, `include/`, `lib/`: Source code and libraries for microcontrollers
|
|
- Compatible with PlatformIO, Arduino, STM32Cube, Zephyr, etc.
|
|
|
|
### `/software/`
|
|
- `gui/`: GUI apps for control or configuration
|
|
- `scripts/`: Helper tools or automation
|
|
|
|
### `/docs/`
|
|
- `overview.md`, `quickstart.md`: Introductory and usage docs
|
|
- `images/`: Diagrams, photos, illustrations
|
|
- `datasheets/`: Reference datasheets for key components
|
|
|
|
### `/tests/`
|
|
- `hardware/`: Hardware test procedures
|
|
- `firmware/`: Firmware unit or integration tests
|
|
- `reports/`: Test logs and validation outputs
|
|
|
|
### `/ci/`
|
|
- GitHub Actions, GitLab CI, or other automation scripts
|
|
|
|
### `/tools/`
|
|
- Developer tools, debug scripts, flashing utilities
|
|
|
|
### `/certs/`
|
|
- Regulatory or environmental compliance documents (e.g., CE, FCC, RoHS)
|
|
|
|
### `/manufacturing/`
|
|
- `assembly/`: Instructions and jigs for assembly
|
|
- `fab/`: Production-ready files for fabrication
|
|
|
|
### `/meta/`
|
|
- `changelog.md`: Development history
|
|
- `authors.md`: Contributors list
|
|
- `b4l_manifest.json`: Optional machine-readable metadata
|
|
|
|
---
|
|
|
|
## 📝 License
|
|
|
|
This template is open source. Use a license that fits your project.
|
|
Recommended for hardware: [CERN-OHL-S-2.0](https://gitlab.com/ohwr/project/cernohl/)
|
|
|
|
---
|
|
|
|
## 🤝 Contributing
|
|
|
|
To start a new project:
|
|
1. Click “Use this template” (on GitHub) or clone this repo
|
|
2. Rename and fill out your project files
|
|
3. Share and collaborate with ease
|
|
|
|
---
|
|
|
|
## 📡 About Build4Life
|
|
|
|
**Build4Life** creates long-lasting, open hardware systems — starting with sustainable LED lighting and modular solar power.
|
|
|
|
Website: [https://buildfor.life](https://buildfor.life)
|