docs: ✏️ update readme (#57)

add development doc ✅ Closes: #56
bingryan · Sep 26, 2023 · 81dcdcc · 81dcdcc
1 parent 6c1b0f6
commit 81dcdcc
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/README-CN.md b/README-CN.md
@@ -94,6 +94,28 @@ sudo spctl --master-disable
 
 ## For Developers
 
+### Development
+
+```bash
+# install dependencies
+pnpm install
+
+# web
+pnpm dev
+
+# desktop
+pnpm tauri dev
+```
+
+### Build(Production)
+
+```bash
+pnpm install
+pnpm build
+pnpm tauri build
+```
+
+
 对于任何形式的 PR 都是欢迎的(文档, UI, 代码)
 
 Q: 1. 为什么 server 层还有一个没用上的 chatgpt 的后端服务

diff --git a/README.md b/README.md
@@ -84,6 +84,27 @@ The left setting block serves as a global setting:
 
 ## For Developers
 
+### Development
+
+```bash
+# install dependencies
+pnpm install
+
+# web
+pnpm dev
+
+# desktop
+pnpm tauri dev
+```
+
+### Build(Production)
+
+```bash
+pnpm install
+pnpm build
+pnpm tauri build
+```
+
 Any form of PR is welcome (documentation, UI, code)
 
 ## Technology Stack and Credits