diff --git a/README.md b/README.md index 4f55f6d..3763d5e 100644 --- a/README.md +++ b/README.md @@ -1 +1,60 @@ # setup_Projekt +Kategorie: Software (Bash) +Erstellt am: 27.04.2026 + +## Tags zur Indizierung +#Projekt #erstellen + +## Notizen------------------------------ + +## Maker-Projekt-Initializer 🛠️ +Dieses Bash-Skript automatisiert das Erstellen einer konsistenten Ordnerstruktur für verschiedene Projekttypen (3D-Druck, CNC, Python und Bash). Es sorgt dafür, dass jedes Projekt sofort mit einer indizierbaren README.md und den passenden Unterordnern startet. +## 🚀 Funktionen + +* Automatisierte Struktur: Erstellt vordefinierte Ordner für Hardware- und Softwareprojekte. +* Verschlagwortung (Tags): Fragt beim Erstellen Schlagworte ab und schreibt diese als #Tags in die Projekt-README für eine blitzschnelle Suche. +* Einsatzfertig: +* Erstellt direkt eine main.py für Python-Projekte. + * Erstellt ein ausführbares .sh-Skript für Bash-Projekte. +* Saubere Benennung: Ersetzt automatisch Leerzeichen im Projektnamen durch Unterstriche. + +## 📂 Die erzeugte Struktur +Je nach Auswahl generiert das Skript folgende Pfade: +## Hardware (01_Hardware_Projekte) + +[Projekt_Name]/ +├── CAD/ # Konstruktionsdateien (STEP, Fusion360 etc.) +├── CAM/ # CNC-Werkzeugpfade & G-Code +├── 3D_Print/ # STL-Dateien & Slicer-Projekte +├── Dokumentation/ # Fotos & Anleitungen +├── Ressourcen/ # Datenblätter & Links +└── README.md # Projektinfo & Tags + +## Software (02_Software_Scripts) + +* Python: Erstellt src/main.py, tests/ und docs/. +* Bash: Erstellt ein direkt ausführbares Skript im Projektordner. + +## 🛠️ Installation & Nutzung + + 1. Skript herunterladen: Speichere das Skript als setup_projekt.sh in deinem Hauptverzeichnis. + 2. Rechte vergeben: + + chmod +x setup_projekt.sh + + 3. Starten: + + ./setup_projekt.sh + + +## 🔍 Indizierung & Suche +Die erzeugte README.md enthält eine Sektion ## Tags zur Indizierung. +Dadurch kannst du Tools wie VS Code, Everything oder die Windows-Suche nutzen, um projektübergreifend nach Schlagworten zu suchen (z.B. Suche nach #Gehäuse oder #Halterung). +------------------------------ +## Tipp für Git-User +Falls du dieses Skript in einem Git-Repo verwaltest, kannst du eine .gitignore hinzufügen, um zu verhindern, dass die später erstellten Projektordner (01_... und 02_...) mit in das Skript-Repo hochgeladen werden, falls das nicht erwünscht ist: + +01_Hardware_Projekte/ +02_Software_Scripts/ + +------------------------------