From 0a164f93cef3d1869a024e8222a4f5865bb9621b Mon Sep 17 00:00:00 2001 From: m1ngsama Date: Wed, 19 Nov 2025 17:58:34 +0800 Subject: [PATCH] docs: Add developer guide to README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 25b6c03..29a2941 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,21 @@ cmake --build . - `↑` / `↓`:上下移动选中事件 - `q`:退出程序 +### Developer Guide + +For contributors and developers, follow these guidelines: + +1. **Clone the Repository:** + ```bash + git clone https://github.com/m1ngsama/TUT.git + cd TUT + ``` +2. **Build Environment Setup:** Ensure all [Dependencies](#dependencies) are installed. +3. **Local Build:** Follow the [构建](#构建) instructions. +4. **Code Style:** Adhere to the existing code style in `src/`. +5. **Testing:** Currently, there are no automated tests. Please manually verify changes. +6. **Contributing:** Submit Pull Requests for new features or bug fixes. + ### 版本 (Version) - `v0.0.1`