Info.md aktualisiert

modified
This commit is contained in:
RainerWieland 2025-11-08 10:07:36 +01:00
parent 720ebc80b1
commit 6d5a151b63

28
Info.md
View File

@ -1,18 +1,8 @@
# Projektname
Kurzbeschreibung: Hardware (ECAD), Mechanik/CAD und Firmware (PlatformIO) mit Dokumentation und Fertigungsunterlagen.
## Verzeichnisstruktur ## Verzeichnisstruktur
``` ```
your-project/ FireNose/
firmware/ - PlatformIO-Projekt (Quellcode, Header, Libs, Tests) 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/ hardware/
ecad/ - KiCad-Quellen (Schaltplan/Layout, Libs, 3D-Modelle) ecad/ - KiCad-Quellen (Schaltplan/Layout, Libs, 3D-Modelle)
@ -33,14 +23,14 @@ your-project/
logos/ - Logos/Marken logos/ - Logos/Marken
.github/ - Issue-/PR-Templates, CI-Workflows .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
``` ```
- **LICENSE** - Software-Lizenz
- **LICENSE-HARDWARE** - Hardware-Lizenz
- **CONTRIBUTING.md** - Beitragsrichtlinien
- **CODE_OF_CONDUCT.md** - Verhaltenskodex
- **SECURITY.md** - Sicherheitsmeldungen
- **RELEASE_NOTES.md** - Release-Historie
## Schnellstart ## Schnellstart
@ -51,4 +41,4 @@ your-project/
## Hinweise ## Hinweise
- PlatformIO erwartet src/, include/, lib/, test/ und platformio.ini fuer reproduzierbare Builds. - 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. - Fuer Bestueckung werden ueblich BOM und CPL/Centroid (Pick and Place/XY) bereitgestellt.