This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Guitar Prometheus Documentation
Project documentation for Guitar Prometheus — the desktop tool that imports
Guitar Pro scores (MusicXML / .gp / .gpx) and converts them to MIDI with
VST keyswitches.
The Forgejo Actions workflow at .forgejo/workflows/publish-docs.yaml
publishes every section under this tree to the project wiki on push to mainline.
The wiki is the canonical reading surface; this repo holds the authoritative
source.
Contents
Architecture
System context, component design, and the architectural decisions that shape the codebase.
| Document | Description |
|---|---|
| Architecture Overview | Pipeline diagram, component layout, data flow |
Development
Contributing guidelines, build / test instructions, coding rules, release tooling, and the wishlist of deferred features.
| Document | Description |
|---|---|
| Building | Local build setup, dependencies, common targets |
| Building on Windows | MSVC + CMake instructions, portable-mode ZIP layout |
| Releases | scripts/build-release.*, CPack generators, smoke procedure |
| Testing | Test architecture, fixtures, running the suite |
| Coding Rules | Style, doc conventions, commit-message format |
| Code-Review Standards | Cross-cutting standards codified in Phases 19 / 20 |
| Techniques | The base Technique set + extension cadence |
| Wishlist | Deferred / future work pulled from feature triage |
Customer
User-facing documentation for the desktop application.
| Document | Description |
|---|---|
| Getting Started | First-run walkthrough: open a project, export MIDI |
| Profile Binding | Bind VST profiles to score parts, edit keyswitches |
| Native Import | .gp / .gpx import workflow + supported techniques |
Agentic Context
Context for AI-assisted development sessions. Not published to the customer wiki; lives alongside the source for agents that operate on this repo.
| Document | Description |
|---|---|
| Project Context | Living state document, decisions, deferred items |
| Agent Designs | Brainstorming output for individual features |
| Agent Plans | Ad-hoc session plans (transient, cleaned periodically) |
| Implementation Plans | Phased plans (1–24 to date) with index + commit map |
API Reference
Auto-generated from Doxygen comments on every commit. Output lives at
documentation/api-reference/ (gitignored). The build script lives at
documentation/scripts/build-api-docs.sh.
Building the API Reference Locally
brew install doxygen doxybook2 # macOS
documentation/scripts/build-api-docs.sh
The script writes Markdown into documentation/api-reference/. The Forgejo
Actions workflow runs the same script on every push and rsyncs the result into
the wiki repo.