updated READMEs

This commit is contained in:
2025-05-21 17:26:26 +07:00
parent 6cff715e74
commit 62159b3c5f
3 changed files with 54 additions and 52 deletions

100
README.md
View File

@@ -1,26 +1,26 @@
# B4L Open Hardware Project Template # B4L Open Hardware Project Template
Welcome to the **Build4Life (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. This repository defines a standard structure for building open-source hardware projects with high transparency, maintainability, and manufacturability.
Use this template to kickstart your own B4L-compatible project. Use this as a base for your own project or as a collaborative standard for contributions.
--- ---
## 📁 Folder Structure ## 📁 Folder Structure
``` ```
hardware/ # Schematics, PCB layout, BOM, manufacturing files hardware/ # Schematics, PCB, component models, libraries
mechanical/ # Mechanical designs and 3D printable enclosures mechanical/ # Enclosures and mechanical CAD
firmware/ # Microcontroller firmware firmware/ # Embedded firmware
software/ # PC-side tools or GUIs software/ # PC-side software and tools
docs/ # User guides, images, datasheets docs/ # Documentation and datasheets
tests/ # Test plans and reports tests/ # Test plans, logs, reports
ci/ # Continuous Integration config ci/ # Continuous Integration configuration
tools/ # Development and debug tools tools/ # Debug and development utilities
certs/ # Certification and compliance documentation certs/ # Certification/compliance files
manufacturing/ # Production-level data for fab and assembly manufacturing/ # Production and assembly resources
meta/ # Project metadata and changelog meta/ # Project changelog and metadata
``` ```
--- ---
@@ -28,80 +28,76 @@ meta/ # Project metadata and changelog
## 📂 Folder Descriptions ## 📂 Folder Descriptions
### `/hardware/` ### `/hardware/`
Contains all electrical design files: - `schematics/`: Electrical schematics in any EDA tool
- `schematics/`: KiCad or EDA schematic files
- `pcb/`: PCB layout files - `pcb/`: PCB layout files
- `bom/`: Bill of Materials - `bom/`: Bill of Materials (CSV, XLSX)
- `manufacturing/`: Gerbers, pick-and-place, drill files - `manufacturing/`: Gerbers, pick-and-place, drill data
- `simulations/`: Simulation circuits (e.g. SPICE) - `simulations/`: SPICE or other circuit simulations
- `component-models/`: 3D models for electronic components
- `libraries/`: Custom symbols, footprints, models
### `/mechanical/` ### `/mechanical/`
Mechanical or enclosure design: - `enclosure/`: 3D-printable housing or case designs
- `enclosure/`: STL/STEP files for 3D-printable parts - `cad/`: Editable CAD models
- `cad/`: Editable CAD models (FreeCAD, Fusion360) - `stl/`: Printable STL files
- `drawings/`: 2D drawings for fabrication or documentation - `drawings/`: 2D mechanical drawings for CNC or documentation
- `stl/`: Final 3D-printable export files
### `/firmware/` ### `/firmware/`
Firmware source code: - `src/`, `include/`, `lib/`: Source code and libraries for microcontrollers
- `src/`, `include/`, `lib/`: Microcontroller code and dependencies - Compatible with PlatformIO, Arduino, STM32Cube, Zephyr, etc.
- Example: PlatformIO, STM32Cube, Arduino, Zephyr
### `/software/` ### `/software/`
Optional software tools, GUI, or helper scripts: - `gui/`: GUI apps for control or configuration
- `gui/`: Any frontend or desktop apps - `scripts/`: Helper tools or automation
- `scripts/`: CLI or backend support tools
### `/docs/` ### `/docs/`
Project documentation: - `overview.md`, `quickstart.md`: Introductory and usage docs
- `overview.md`, `quickstart.md`, photos, diagrams - `images/`: Diagrams, photos, illustrations
- `datasheets/`: PDFs of important components - `datasheets/`: Reference datasheets for key components
### `/tests/` ### `/tests/`
Hardware and firmware testing: - `hardware/`: Hardware test procedures
- `hardware/`: Test jigs, test instructions - `firmware/`: Firmware unit or integration tests
- `firmware/`: Unit and integration test code - `reports/`: Test logs and validation outputs
- `reports/`: Test results, logs, and photos
### `/ci/` ### `/ci/`
Automation and CI pipelines: - GitHub Actions, GitLab CI, or other automation scripts
- GitHub Actions, GitLab CI, etc.
### `/tools/` ### `/tools/`
Developer tools, flashing utilities, debug helpers - Developer tools, debug scripts, flashing utilities
### `/certs/` ### `/certs/`
Regulatory and certification documents (e.g., CE, FCC) - Regulatory or environmental compliance documents (e.g., CE, FCC, RoHS)
### `/manufacturing/` ### `/manufacturing/`
Everything needed for production: - `assembly/`: Instructions and jigs for assembly
- `assembly/`: Instructions for assembly/test stations - `fab/`: Production-ready files for fabrication
- `fab/`: Files needed by PCB fab houses
### `/meta/` ### `/meta/`
Project metadata: - `changelog.md`: Development history
- `b4l_manifest.json`: Name, version, tags, license - `authors.md`: Contributors list
- `authors.md`, `changelog.md` - `b4l_manifest.json`: Optional machine-readable metadata
--- ---
## 📝 License ## 📝 License
This template is open source. Choose a license appropriate for your project. This template is open source. Use a license that fits your project.
Recommended: [CERN-OHL-S-2.0](https://gitlab.com/ohwr/project/cernohl/) for open hardware. Recommended for hardware: [CERN-OHL-S-2.0](https://gitlab.com/ohwr/project/cernohl/)
--- ---
## 🤝 Contributing ## 🤝 Contributing
If youre creating a new B4L-compatible project, click “Use this template” or clone this repository. To start a new project:
1. Click “Use this template” (on GitHub) or clone this repo
Youre encouraged to submit improvements to this template! 2. Rename and fill out your project files
3. Share and collaborate with ease
--- ---
## 📡 About Build4Life ## 📡 About Build4Life
**Build4Life** is a community-driven initiative designing durable, open, and maintainable electronics. **Build4Life** creates long-lasting, open hardware systems — starting with sustainable LED lighting and modular solar power.
Website: [https://buildfor.life](https://buildfor.life) Website: [https://buildfor.life](https://buildfor.life)

View File

@@ -0,0 +1,3 @@
# /hardware/component-models
3D models of components (STEP, WRL, etc.) for mechanical integration.

View File

@@ -0,0 +1,3 @@
# /hardware/libraries
Custom libraries for component symbols, footprints, and models.