diff --git a/Info.md b/Info.md new file mode 100644 index 0000000..a76b490 --- /dev/null +++ b/Info.md @@ -0,0 +1,44 @@ +## Verzeichnisstruktur + +``` +FireNose/ + firmware/ - PlatformIO-Projekt (Quellcode, Header, Libs, Tests) + + 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 +- **LICENSE-HARDWARE** - Hardware-Lizenz +- **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) bereitgestellt.