From 718391adbeac9b2ebed75ddffef45a4458f5af91 Mon Sep 17 00:00:00 2001 From: Centurion_Prime Date: Sat, 19 Oct 2024 11:19:24 +0200 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 54c729a..26d14e4 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file