Update README.md

This commit is contained in:
Centurion_Prime 2024-10-19 11:19:24 +02:00
parent 2ef8d55436
commit 718391adbe

View file

@ -1,2 +1,24 @@
# TSGC
# The Suyu Grand Codex (TSGC)
Welcome to The Suyu Grand Codex (TSGC), the definitive guide to the Suyu Nintendo Switch emulator! This documentation project aims to be a comprehensive resource for developers who want to understand, contribute to, and extend the Suyu emulator.
**Current Status:** Pre-alpha
**Goals**
* **Comprehensive Coverage:** Provide in-depth explanations of Suyu's architecture, codebase, and functionalities.
* **Accessibility:** Make the documentation accessible to both beginner and experienced developers.
* **Practical Guidance:** Offer practical tutorials and examples to guide developers through contributing to Suyu.
* **Community Collaboration:** Foster a collaborative environment where developers can share their knowledge and contribute to the documentation.
**Contributing**
We welcome contributions from the Suyu community! If you'd like to help improve the documentation, feel free to submit pull requests or open issues.
**License**
This documentation is licensed under the [MIT License](LICENSE).
**Contact**
If you have any questions or feedback, please contact Centurion_Prime.