Merge pull request #125 from rocboss/rocboss-patch-1

optimize docs.

README.md

@@ -70,11 +70,12 @@ PaoPao主要由以下优秀的开源项目/工具构建
 
 ### 安装说明
 
-***宝塔安装***
 
-我们为宝塔用户提供了超详细安装教程 [点此查看](https://www.rocs.me/archives/paopao_bt_install.html)
+### 方式一. 宝塔安装
 
-***普通安装***
+我们为宝塔用户提供了超详细安装教程(v0.1.0版本)，仅供参考，[点此查看](https://www.rocs.me/archives/paopao_bt_install.html)
+
+### 方式二. 手动安装
 
 克隆代码库
 
@@ -154,49 +155,51 @@ PaoPao主要由以下优秀的开源项目/工具构建
    的，需要安装tauri的依赖，具体参考[https://tauri.studio/v1/guides/getting-started/prerequisites](https://tauri.studio/v1/guides/getting-started/prerequisites).
 
 
-### 使用Docker构建、运行
+### 方式三. 使用Docker构建、运行
   * 后端:
   ```sh
   # 默认参数构建, 默认内嵌web ui并设置api host为空
-  %> docker build -t your/paopao-ce:tag .
+  docker build -t your/paopao-ce:tag .
 
   # 内嵌web ui并且自定义API host参数
-  %> docker build -t your/paopao-ce:tag --build-arg API_HOST=http://paopao.info .
+  docker build -t your/paopao-ce:tag --build-arg API_HOST=http://paopao.info .
 
   # 内嵌web ui并且使用本地web/.env中的API host
-  %> docker build -t your/paopao-ce:tag --build-arg USE_API_HOST=no .
+  docker build -t your/paopao-ce:tag --build-arg USE_API_HOST=no .
 
   # 内嵌web ui并且使用本地编译的web/dist构建
-  %> docker build -t your/paopao-ce:tag --build-arg USE_DIST=yes .
+  docker build -t your/paopao-ce:tag --build-arg USE_DIST=yes .
 
   # 只编译api server
-  %> docker build -t your/paopao-ce:tag --build-arg EMBED_UI=no .
+  docker build -t your/paopao-ce:tag --build-arg EMBED_UI=no .
 
   # 运行
-  %> docker run -p 8008:8008 -v ${PWD}/config.yaml.sample:/app/paopao-ce/config.yaml your/paopao-ce:tag
+  docker run -p 8008:8008 -v ${PWD}/config.yaml.sample:/app/paopao-ce/config.yaml your/paopao-ce:tag
   ```
 
   * 前端:
   ```sh
-  %> cd web
+  cd web
 
   # 默认参数构建
-  %> docker build -t your/paopao-ce:web .
+  docker build -t your/paopao-ce:web .
 
   # 自定义API host 参数构建
-  %> docker build -t your/paopao-ce:web --build-arg API_HOST=http://paopao.info .
+  docker build -t your/paopao-ce:web --build-arg API_HOST=http://paopao.info .
 
   # 使用本地编译的dist构建
-  %> docker build -t your/paopao-ce:web --build-arg USE_DIST=yes .
+  docker build -t your/paopao-ce:web --build-arg USE_DIST=yes .
   ```
 
-### 使用 docker-compose 运行
+### 方式四. 使用 docker-compose 运行
 ```sh
-%> git clone https://github.com/rocboss/paopao-ce.git
+git clone https://github.com/rocboss/paopao-ce.git
-%> docker compose up --build
+docker compose up --build
 # visit paopao-ce(http://127.0.0.1:8008) and phpMysqlAdmin(http://127.0.0.1:8080)
 ```
+
 默认是使用config.yaml.sample的配置，如果需要自定义配置，请拷贝默认配置文件(比如config.yaml)，修改后再同步配置到docker-compose.yaml如下：
+
 ```
 # file: docker-compose.yaml
 ...
@@ -217,24 +220,29 @@ PaoPao主要由以下优秀的开源项目/工具构建
       - paopao-network
 ....
 ```
-***注意：默认提供的 docker-compose.yaml 仅仅用于搭建本机开发调试环境，paopao-ce/phpMysqlAdmin 默认只能本机访问，如果需要产品部署供外网访问，请自行修改配置参数或使用其他方式部署。***
+
+> 注意：默认提供的 docker-compose.yaml 仅用于搭建本机开发调试环境，paopao-ce/phpMysqlAdmin 默认只能本机访问，如果需要产品部署供外网访问，请自行修改配置参数或使用其他方式部署。
 
 ### API 文档
 构建时将 `docs` 添加到TAGS中:
 ```sh
-%> make run TAGS='docs'
+make run TAGS='docs'
+
 # visit http://127.0.0.1:8008/docs
 ```
 
-### 关于config.yaml
+### 配置说明
-`config.yaml.sample` 是一份完整的配置文件模版，paopao-ce启动时会读取configs/config.yaml、./config.yaml任意一份配置文件（优先读取最先找到的文件）。
+
+`config.yaml.sample` 是一份完整的配置文件模版，paopao-ce启动时会读取`./configs/config.yaml`、`./config.yaml`任意一份配置文件（优先读取最先找到的文件）。
 
 ```sh
-%> cp config.yaml.sample config.yaml
+cp config.yaml.sample config.yaml
-%> vi config.yaml # 修改参数
+vim config.yaml # 修改参数
-%> paopao-ce
+paopao-ce
 ```
+
 配置文件中的 `Features` 小节是声明paopao-ce运行时开启哪些功能项:
+
 ```yaml
 ...
 
@@ -250,24 +258,33 @@ Features:
 ...
 ```
 
-如上： Default/Develop/Demo/Slim 是不同 功能集套件(Features Suite)， Base/Option 是子功能套件， Sms是关于短信验证码功能的参数选项。
+如上： 
-这里 `Default`套件 代表的意思是： 使用`Base/Option` 中的功能 外加 `MySQL/LocalOSS/LoggerFile`功能，也就是说开启了`Zinc/Redis/Alipay/SimpleCacheIndex/MySQL/LocalOSS/LoggerFile` 7项功能； `Develop`套件依例类推。 使用Feautures:
+Default/Develop/Demo/Slim 是不同 功能集套件(Features Suite)， Base/Option 是子功能套件， Sms是关于短信验证码功能的参数选项。
+
+这里 `Default`套件 代表的意思是： 使用`Base/Option` 中的功能，外加 `MySQL/LocalOSS/LoggerFile`功能，也就是说开启了`Zinc/Redis/Alipay/SimpleCacheIndex/MySQL/LocalOSS/LoggerFile` 7项功能； 
+`Develop`套件依例类推。 
+
+使用Feautures:
 
 ```sh
-%> release/paopao-ce --help
+release/paopao-ce --help
 Usage of release/paopao-ce:
   -features value
         use special features
   -no-default-features
         whether use default features
 
-%> release/paopao-ce # 默认使用 Default 功能套件
+# 默认使用 Default 功能套件
+release/paopao-ce 
 
-%> release/paopao-ce --no-default-features --features develop # 不包含 default 中的功能集，仅仅使用 develop 中声明的功能集
+# 不包含 default 中的功能集，仅仅使用 develop 中声明的功能集
+release/paopao-ce --no-default-features --features develop 
 
-%> release/paopao-ce --features sms  # 使用 default 中的功能集，外加 sms 功能
+# 使用 default 中的功能集，外加 sms 功能
+release/paopao-ce --features sms  
 
-%> release/paopao-ce --no-default-features --features sqlite3,localoss,loggerfile,redis # 手动指定需要开启的功能集
+# 手动指定需要开启的功能集
+release/paopao-ce --no-default-features --features sqlite3,localoss,loggerfile,redis 
 ```
 
 目前支持的功能集合: