gaoshuaixing 5 år sedan
förälder
incheckning
514cd9ea2e
1 ändrade filer med 58 tillägg och 1 borttagningar
  1. 58 1
      README.md

+ 58 - 1
README.md

@@ -1,2 +1,59 @@
 # electron-egg
-A fast, desktop software development framework
+一个快速、功能丰富的桌面软件开发框架,基于electron和egg.js
+
+## 1
+
+## 开始使用
+
+1. 下载
+```
+# gitee
+git clone https://gitee.com/wallace5303/electron-egg.git
+# github
+git clone https://github.com/wallace5303/electron-egg.git
+```
+
+2. 启动
+    ```
+    # 进入目录 ./electron-egg/
+    npm install
+    npm run dev
+    ```
+3. 常用命令
+    ```
+    # 开发者模式
+    npm run dev
+    # 生产者模式
+    npm run start
+    # 打包 (windows版本)
+    npm run build-w
+    # 打包 (mac版本)
+    npm run build-m
+    # 打包 (linux版本)
+    npm run build-l
+    ```
+
+## 日志
+1. electron日志:./logs/main.log
+2. egg日志:./logs/
+
+## 文档
+[查看](http://box.kaka996.com/)
+
+## 项目案例
+
+1. 网址管理大师
+![](https://i.loli.net/2020/11/02/ByFDKeY6nmdxGoc.png)
+[体验](http://box.kaka996.com/)
+
+注:# 联系作者(邮箱:530353222@qq.com)展示你的项目
+
+## 进行中功能
+1. 软件自动更新
+2. 数据本地存储
+3. mac版功能兼容
+
+## 欢迎star
+
+
+