Welcome to the Firelands project. This emulator is being developed with a focus on modern software engineering practices.
We operate under a strict set of "Skills" to maintain code quality and architectural integrity:
- Project language: Code and public APIs are written in English. Skill 01
- Hexagonal Architecture: Decoupling business logic from external systems. Skill 02
- TDD (Test-Driven Development): Logic is driven by tests. Skill 03
- Modern Tech Stack: C++20, CMake, MySql, and RESTful APIs. Skill 04
- Build Optimization: Fast builds using ccache, Ninja, and PCH. Skill 05
- Cross-Platform: Support for Windows, Linux, and macOS.
To get started:
- Ensure you have CMake and a C++20 compliant compiler.
- Follow the documentation index in
docs/for module-by-module guidance (SQL, build, tests, tools, etc.).
- Docs index (language picker):
docs/README.md - English documentation:
docs/EN/README.md - Documentación en español:
docs/ES/README.md