A: 中文开发文档

README.md

@@ -3,6 +3,8 @@ A simple local markdown tool, use Tauri & Vditor & Vue3
 
 Maybe we can call it `TMD` ? 🤔
 
+[简体中文](README.zh.md)
+
 (tag v0.1.0 used vue2)
 
 ## Develop
@@ -32,6 +34,8 @@ npm run tauri build
 ## Known issue
 
 - [x] Tauri cannot use the application hotkey `copy/paste` see: https://github.com/tauri-apps/tauri/pull/644
+- [ ] The outline title does not jump (vditor in tauri)
+- [ ] The `sv mode` cursor problem (vditor in tauri) 
 
 ## Roadmap
 see: https://github.com/jeeinn/tauri-markdown/discussions/1

README.zh.md

@@ -0,0 +1,46 @@
+# Tauri Markdown
+一个简单的本地 Markdown 工具, 使用 Tauri & Vditor & Vue3
+
+我们也可以叫它 `TMD` ? 🤔
+
+[English](README.md)
+
+(tag v0.1.0 used vue2)
+
+## 开发说明
+
+### 安装 Tauri && tauri-bundler
+
+查看 Tauri 官方文档: [文档](https://tauri.app/v1/guides/)
+
+### 项目配置
+
+```
+npm install
+```
+
+### 开发和热更新
+
+```
+npm run tauri dev
+```
+
+### 编译发布
+
+```
+npm run tauri build
+```
+
+## 已知问题
+
+- [x] Tauri 不能使用应用热键 `copy/paste` 查看问题: https://github.com/tauri-apps/tauri/pull/644
+- [ ] 大纲视图标题不能跳转 (vditor in tauri)
+- [ ] 分屏模式有光标问题 (vditor in tauri)
+
+## 路线图
+查看: https://github.com/jeeinn/tauri-markdown/discussions/1
+
+## 感谢
+* [tauri](https://github.com/tauri-apps/tauri)
+* [vditor](https://github.com/Vanessa219/vditor)
+* [element-plus](https://github.com/element-plus/element-plus)