From 720ebc80b1f271e335a3457ea296719c69d9cab4 Mon Sep 17 00:00:00 2001 From: RainerWieland Date: Sat, 8 Nov 2025 10:00:59 +0100 Subject: [PATCH] =?UTF-8?q?Info.md=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added --- Info.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 Info.md diff --git a/Info.md b/Info.md new file mode 100644 index 0000000..22f8494 --- /dev/null +++ b/Info.md @@ -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.