Was macht skill-creator?
Ein Codex-Skill zur Standardisierung von C++/CMake/Qt-Projektverzeichnisstrukturen mit klaren Regeln für Quellcode, Header, QML, Ressourcen, Abhängigkeiten, Skripte, Dokumentation, Tests und Migration von Legacy-Projekten.
Verwendung
- Installation: Fügen Sie
honeyyaya/skill-creatorzu Ihrer Codex-Konfiguration hinzu. - Initialisierung: Führen Sie den Befehl
codex createin Ihrem Projektverzeichnis aus, um die Standardverzeichnisstruktur zu generieren. - Anpassung: Bearbeiten Sie die generierte
codex.yml-Datei, um Regeln nach Bedarf anzupassen.
Standard-Verzeichnisstruktur
projekt/
├── src/ # Quellcode (.cpp, .hpp, .h)
├── include/ # Öffentliche Header (für Bibliotheken)
├── qml/ # QML-Dateien
├── resources/ # Ressourcendateien (Bilder, Übersetzungen, etc.)
├── dependencies/ # Externe Abhängigkeiten (z. B. Git-Submodule)
├── scripts/ # Build- und Hilfsskripte
├── docs/ # Projektdokumentation
├── tests/ # Unit-Tests und Integrationstests
├── CMakeLists.txt # Haupt-CMake-Datei
└── README.md # Projektbeschreibung
Regeln
- src/: Alle
.cpp- und.hpp-Dateien, die Teil der ausführbaren Datei oder Bibliothek sind. - include/: Öffentliche Header, die von anderen Modulen oder Projekten verwendet werden.
- qml/: QML-Dateien für Qt Quick-Oberflächen.
- resources/: Ressourcendateien wie Bilder, Symbolleisten, Übersetzungsdateien (
.ts,.qm). - dependencies/: Verwalten Sie Abhängigkeiten mit Git-Submodulen oder CMake-FetchContent.
- scripts/: Build-Skripte (
.sh,.bat,.ps1), CI/CD-Konfigurationen. - docs/: Dokumentation im Markdown- oder Doxygen-Format.
- tests/: Testdateien, die mit CTest oder Qt Test Framework ausgeführt werden.
Migration von Legacy-Projekten
- Sichern Sie Ihr bestehendes Projekt.
- Führen Sie
codex migrateaus, um Dateien automatisch in die neue Struktur zu verschieben. - Überprüfen Sie die verschobenen Dateien und passen Sie
CMakeLists.txtentsprechend an. - Aktualisieren Sie Include-Pfade und Abhängigkeiten.
Beispiele
Erstellen eines neuen Projekts
mkdir mein-qt-projekt
cd mein-qt-projekt
codex create
Migrieren eines bestehenden Projekts
cd legacy-projekt
codex migrate
Unterstützung
Bei Fragen oder Problemen öffnen Sie bitte ein Issue im GitHub-Repository.
Lizenz
Dieses Projekt ist unter der MIT-Lizenz lizenziert.