Info.md hinzugefügt
Added
This commit is contained in:
parent
571bf3f6e5
commit
720ebc80b1
54
Info.md
Normal file
54
Info.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# Projektname
|
||||
|
||||
Kurzbeschreibung: Hardware (ECAD), Mechanik/CAD und Firmware (PlatformIO) mit Dokumentation und Fertigungsunterlagen.
|
||||
|
||||
## Verzeichnisstruktur
|
||||
|
||||
```
|
||||
your-project/
|
||||
firmware/ - PlatformIO-Projekt (Quellcode, Header, Libs, Tests)
|
||||
src/ - Anwendungscode (Einstieg: main.cpp)
|
||||
include/ - Header und Projektkonfiguration
|
||||
lib/ - Projektspezifische Libraries/Module
|
||||
test/ - Unit-/Integrationstests (pio test)
|
||||
scripts/ - Build-/Post-Build-Skripte (optional)
|
||||
platformio.ini - Build-Umgebungen, Boards, Optionen
|
||||
|
||||
hardware/
|
||||
ecad/ - KiCad-Quellen (Schaltplan/Layout, Libs, 3D-Modelle)
|
||||
libraries/ - Symbole, Footprints (.pretty), Parameter
|
||||
3dmodels/ - STEP/WRL von Bauteilen
|
||||
manufacturing/ - Fertigung/Bestueckung (generierte Artefakte)
|
||||
gerber/ - Plot-Layer (RS-274X)
|
||||
drill/ - Bohrdaten (Excellon)
|
||||
assembly/ - BOM (Stueckliste), CPL/Centroid (Pick and Place)
|
||||
|
||||
mechanical/
|
||||
cad/ - Parametrische CAD-Quellen (z. B. FreeCAD)
|
||||
exports/ - Neutrale Exporte (STEP/STL) fuer Austausch
|
||||
|
||||
docs/ - Getting Started, Build/Test, Hardware/Mechanical Overview
|
||||
assets/
|
||||
images/ - Renderings/Fotos
|
||||
logos/ - Logos/Marken
|
||||
|
||||
.github/ - Issue-/PR-Templates, CI-Workflows
|
||||
|
||||
LICENSE - Software-Lizenz (z. B. MIT/Apache-2.0)
|
||||
LICENSE-HARDWARE - Hardware-Lizenz (z. B. CERN-OHL-v2)
|
||||
CONTRIBUTING.md - Beitragsrichtlinien
|
||||
CODE_OF_CONDUCT.md - Verhaltenskodex
|
||||
SECURITY.md - Sicherheitsmeldungen
|
||||
RELEASE_NOTES.md - Release-Historie
|
||||
```
|
||||
|
||||
## Schnellstart
|
||||
|
||||
- Voraussetzungen: Git, Python, PlatformIO CLI/VS Code.
|
||||
- Build: In firmware/ pio run; Upload: pio run -t upload; Tests: pio test.
|
||||
- Doku: docs/getting-started.md und docs/build-and-test.md.
|
||||
|
||||
## Hinweise
|
||||
|
||||
- PlatformIO erwartet src/, include/, lib/, test/ und platformio.ini fuer reproduzierbare Builds.
|
||||
- Fuer Bestueckung werden ueblich BOM und CPL/Centroid (Pick and Place/XY) benoetigt.
|
||||
Loading…
Reference in New Issue
Block a user