From 69ec57669efec0dcc3aa24cbbdb6f2180809840b Mon Sep 17 00:00:00 2001 From: kuaifan Date: Sat, 2 Mar 2024 14:11:52 +0800 Subject: [PATCH] =?UTF-8?q?perf:=20=E6=9B=B4=E6=96=B0=E8=AF=B4=E6=98=8E?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 +++++++---- README_CLIENT.md | 8 ++++++-- README_CN.md | 11 +++++++---- README_PUBLISH.md | 2 +- 4 files changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 02006950f..08ff09c94 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ English | **[中文文档](./README_CN.md)** -- [Screenshot Preview](README_PREVIEW.md) +- [Screenshot preview](./README_PREVIEW.md) - [Demo site](http://www.dootask.com/) **QQ Group** @@ -12,8 +12,9 @@ Group No.: `546574618` ## Setup - `Docker v20.10+` & `Docker Compose v2.0+` must be installed -- System: `Centos/Debian/Ubuntu/macOS` +- System: `Centos/Debian/Ubuntu/macOS/Windows` - Hardware suggestion: 2 cores and above 4G memory +- Special note: Windows users please use `git bash` or `cmder` to run the command ### Deployment (Pro Edition) @@ -66,11 +67,13 @@ cd dootask ### Development compilation +- `NodeJs 18+` must be installed + ```bash -# Development mode, Mac OS only +# Development ./cmd dev -# Production projects, macOS only +# Production (This is web client. For App/PC/Mac clients, Please read README-CLIENT.md) ./cmd prod ``` diff --git a/README_CLIENT.md b/README_CLIENT.md index 7b54c7a99..65f044329 100644 --- a/README_CLIENT.md +++ b/README_CLIENT.md @@ -3,19 +3,23 @@ ## 1、App客户端 #### 1.1、说明 + 目录 `resources/mobile`,使用`eeui.app`框架,遵从eeui的开发文档进行打包开发app #### 1.2、编译App -1. 在项目目录执行 `./cmd appbuild` 编译 + +1. 在项目目录执行 `./cmd appbuild [build|setting]` 编译 2. 进入 `resources/mobile` eeui框架内打包Android或iOS应用 ## 2、PC/Mac客户端 #### 2.1、说明 + 目录 `electron`,使用`electron`框架,遵从electron的开发文档进行打包客户端 #### 2.2、编译客户端 -在项目目录执行 `./cmd electron` 根据提示编译 + +在项目目录执行 `./cmd electron [dev]` 根据提示编译 diff --git a/README_CN.md b/README_CN.md index ebc02d25f..96f391ca7 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,7 +2,7 @@ **[English](./README.md)** | 中文文档 -- [截图预览](README_PREVIEW.md) +- [截图预览](./README_PREVIEW.md) - [演示站点](http://www.dootask.com/) **QQ交流群** @@ -12,8 +12,9 @@ ## 安装程序 - 必须安装:`Docker v20.10+` 和 `Docker Compose v2.0+` -- 支持环境:`Centos/Debian/Ubuntu/macOS` +- 支持环境:`Centos/Debian/Ubuntu/macOS/Windows` - 硬件建议:2核4G以上 +- 特别说明:Windows 用户请使用 `git bash` 或者 `cmder` 运行命令 ### 部署项目(Pro版) @@ -66,11 +67,13 @@ cd dootask ### 开发编译 +- 请确保你已经安装了 `NodeJs 18+` + ```bash -# 开发模式,仅限macOS +# 开发模式 ./cmd dev -# 编译项目,仅限macOS +# 编译项目(这是网页端的,App/Pc/Mac客户端请查看 README_CLIENT.md) ./cmd prod ``` diff --git a/README_PUBLISH.md b/README_PUBLISH.md index fb1f1ee9f..b12dedf40 100644 --- a/README_PUBLISH.md +++ b/README_PUBLISH.md @@ -22,5 +22,5 @@ ## 编译App -1. 执行 `./cmd appbuild` 或 `./cmd appbuild setting` 编译 +1. 执行 `./cmd appbuild [setting]` 编译 2. 进入 `resources/mobile` eeui框架内打包Android或iOS应用