feat: doc

herry-go · Dec 6, 2024 · f24c586 · f24c586
1 parent 9dd6581
commit f24c586
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+# template-helper
+* 一个支持yaml格式模板编辑和预览的gui工具，使用fyne框架开发
+
+## 打包
+```bash
+bash build.sh
+```
+
+## 安装
+```bash
+make user-install
+```
+
+## 卸载
+```bash
+make user-uninstall
+```
+
+
+## 功能说明
+- 首页
+  ![image](./data/images/1.png)
+- 选择模板文件（yaml格式）
+  ![image](./data/images/2.png)
+- 预览和编辑模板（基础信息）
+  ![image](./data/images/3.png)
+- 预览和编辑模板（主机信息）
+  ![image](./data/images/4.png)
+- 预览和编辑模板（资源信息）
+  ![image](./data/images/5.png)
+- 预览和编辑模板（基础配置）
+  ![image](./data/images/6.png)
+- 预览和编辑模板（执行步骤）
+  ![image](./data/images/7.png)
+- 保存模板
+  ![image](./data/images/8.png)    
diff --git a/data/images/1.png b/data/images/1.png
diff --git a/data/images/2.png b/data/images/2.png
diff --git a/data/images/3.png b/data/images/3.png
diff --git a/data/images/4.png b/data/images/4.png
diff --git a/data/images/5.png b/data/images/5.png
diff --git a/data/images/6.png b/data/images/6.png
diff --git a/data/images/7.png b/data/images/7.png
diff --git a/data/images/8.png b/data/images/8.png