优化项目的文档

Author: getActivity

HelpDoc.md

@@ -0,0 +1,56 @@
+#### 目录
+
+* [文件 xxx.command 无法执行因为您没有正确的访问权限](#文件-xxxcommand-无法执行因为您没有正确的访问权限)
+
+* [在 Windows 运行 bat 脚本出现终端出现一大堆代码报错怎么处理呢](#在-windows-运行-bat-脚本出现终端出现一大堆代码报错怎么处理呢)
+
+#### 文件 xxx.command 无法执行因为您没有正确的访问权限
+
+* 这个问题是 macOs 或 Linux 运行脚本时没有添加执行权限导致的，为脚本添加执行权限即可，具体步骤如下：
+
+    * 进入项目根目录（xxx 请替换成项目所在路径）
+
+    ```bash
+    cd xxx/AndroidCmdTools
+    ```
+
+    * 递归为所有脚本文件添加执行权限
+
+    ```bash
+    find . -type f -exec chmod +x {} \;
+    ```
+
+#### 在 Windows 运行 bat 脚本出现终端出现一大堆代码报错怎么处理呢
+
+![](picture/windowsBashError.png)
+
+* 出现这个问题，大概率是你的电脑配置了 `Bash` 环境，但是这个 `Bash` 环境有问题导致的，需要先对问题进行排查：
+
+* 第一步：先排查当前 Windows 版本是否和 `Git Bash` 有冲突，在桌面右击空白处，选择 `Git Bash Here`，打开 `Git Bash` 终端，执行命令 `bash --version`
+
+    * 如果鼠标右键不能找到 `Git Bash Here` 选项，则请找到 Git 安装目录，例如 `C:\Program Files\Git\bin`，找到 `bash.exe` 的程序，然后点击运行即可
+
+    * 如果是无法打开 `Git Bash` 终端的情况，则证明当前的 `Git Bash` 版本和当前 Windows 存在冲突，解决方案如下：
+
+        * 去系统环境变量配置中，移除刚刚给 Git Bash 配置的环境变量，即前面配置的 `C:\Program Files\Git\bin`，移除该环境变量不会影响使用 Git 命令
+
+        * 请下载并解压 [WindowsBash](https://github.com/getActivity/AndroidCmdTools/releases/download/1.0/WindowsBash.zip)，推荐解压到 `C:\Program Files\WindowsBash` 这个目录下
+
+        * 在系统环境变量 Path 中，添加 WindowsBash 所在的路径，例如 `C:\Program Files\WindowsBash\bin`，然后保存修改
+
+        * 关闭已打开的所有命令行窗口，然后同时按下 `Windows 键 + R 键`，输入 `Cmd` 打开 `命令行提示符` 窗口，执行命令 `bash --version`
+
+            * 如果输出版本信息，则表示配置成功
+
+            * 如果没有输出任何信息，则表示配置有问题，请通过提 [issue](https://github.com/getActivity/AndroidCmdTools/issues) 来提交你的问题
+
+    * 如果运行 `bash --version` 能输出版本信息，则表示 `Git Bash` 是正常安装的，可以进入下一步排查
+
+* 第二步：再排查 Windows 系统是否存在不同版本的 `Bash` 环境，分别在 `Git Bash`、`Cmd` 这几个终端窗口分别运行 `bash --version` 命令
+
+    * 如果运行 `bash --version` 能输出的结果不一样，则证明电脑存在多个 `Bash` 环境，则应该应该删除多余的 Bash 环境，仅保留 `Git Bash` 环境即可
+
+        * 在 `Cmd` 终端运行 `where bash` 命令，这个命令会输出当前系统环境变量中所有 `bash.exe` 的完整路径，请自行到系统环境变量中进行剔除
+
+    * 如果运行 `bash --version` 能输出的结果一样，则证明 `Bash` 环境配置没有问题，如果到这一步你还是无法定位到问题，请通过提 [issue](https://github.com/getActivity/AndroidCmdTools/issues) 来提交你的问题
+

README.md

@@ -28,75 +28,51 @@
 
 * 一. 下载项目到本地
 
-    * 克隆项目（推荐，可通过 Git 更新）
+    * 克隆项目（推荐，可通过 `Git` 更新）
 
-    * 下载项目（不推荐，无法通过 Git 更新）
+    * 下载项目（不推荐，无法通过 `Git` 更新）
 
-* 二. 为脚本添加执行权限（macOs 或 Linux 系统必须，Windows 可跳过此步骤）
+* 二. 集成 `Shell Bash` 环境（Windows 系统必须，macOs 或 Linux 系统可跳过此步骤）
 
-    * 进入项目根目录（xxx 请替换成项目所在路径）
-    
-    ```bash
-    cd xxx/AndroidCmdTools
-    ```
-    
-    * 递归为所有脚本文件添加执行权限
-    
-    ```bash
-    find . -type f -exec chmod +x {} \;
-    ```
-
-* 三. 集成 Shell Bash 环境（Windows 系统必须，macOs 或 Linux 系统可跳过此步骤）
-
-    * 下载 Git Bash 工具
+    * 下载 `Git Bash` 工具
 
-        * 由于 Git Bash 是捆绑在 Git 工具中的，所以需要下载 Git 工具
+        * 由于 `Git Bash` 是捆绑在 `Git` 工具中的，所以需要下载 `Git` 工具
 
             * [Windows Git 下载](https://git-scm.com/install/windows)
 
             * [macOs Git 下载](https://git-scm.com/install/mac)
 
             * [Linux Git 下载](https://git-scm.com/install/linux)
 
-    * 安装 Git Bash 工具
+    * 安装 `Git Bash` 工具
 
-        * 在安装 Git 的时候勾选安装 `Git Bash Here` 选项
+        * 在安装 `Git` 的时候勾选安装 `Git Bash Here` 选项
 
-    * 配置 Git Bash 环境
+    * 配置 `Git Bash` 环境
 
-        * 注意事项：Git 在安装时默认只配置了 Git 环境，没有配置 Git Bash 环境
+        * 注意事项：`Git` 在安装时默认只配置了 `Git` 环境，没有配置 `Git Bash` 环境
 
-        * 注意覆盖安装 Git 很可能会导致 Git Bash 环境变量丢失，需要重新配置
+        * 注意覆盖安装 `Git` 很可能会导致 `Git Bash` 环境变量丢失，需要重新配置
 
     * 配置 Windows 系统环境变量
 
         * 右击 `我的电脑` —> 点击 `属性` —> 点击 `高级系统设置`
 
-        * 在系统环境变量找到 Path 中，添加 Git Bash 所处的路径，例如 `C:\Program Files\Git\bin`
+        * 在系统环境变量找到 `Path` 中，添加 `Git Bash` 所处的路径，例如 `C:\Program Files\Git\bin`
 
         * 在 `编辑系统变量` 窗口中保存修改，点击 `确定` 按钮
 
         * 在 `系统变量` 窗口也要保存修改，点击 `确定` 按钮
 
         * 在 `系统属性` 窗口也要保存修改，点击 `确定` 按钮
 
-    * 验证 Git Bash 环境是否配置成功
+    * 验证 `Git Bash` 环境是否配置成功
 
         * 关闭已打开的所有命令行窗口
 
-        * 在桌面右击空白处，选择 `Git Bash Here`，打开 Git Bash 终端，执行命令 `bash --version`，如果输出版本信息，则表示配置成功
-
-        * 若你无法通过 `Git Bash Here` 打开 Git Bash 的终端窗口，又或者运行 bat 脚本出现报错，则证明你前面安装的 Git Bash 和当前 Windows 系统版本可能存在兼容问题，解决方法如下：
-
-            * 去系统环境变量配置中，移除刚刚给 Git Bash 配置的环境变量，即前面配置的 `C:\Program Files\Git\bin`，移除该环境变量不会影响使用 Git 命令
-
-            * 下载 [WindowsBash](https://github.com/getActivity/AndroidCmdTools/releases/download/1.0/WindowsBash.zip)，解压 WindowsBash 压缩包，推荐解压到 `C:\Program Files\WindowsBash` 这个目录下
-
-            * 然后尝试打开 `C:\Program Files\WindowsBash\bin\bash.exe` 看看是否能正常打开 Bash 终端，如果能正常打开，则说明 WindowsBash 兼容当前 Windows 系统
-
-            * 在系统环境变量 Path 中，添加 WindowsBash 所在的路径，例如 `C:\Program Files\WindowsBash\bin`，然后保存修改
+        * 关闭已打开的所有命令行窗口，然后同时按下 `Windows 键 + R 键`，输入 `cmd` 打开 `命令行提示符` 窗口，执行命令 `bash --version`，如果输出版本信息，则表示配置成功
 
-            * 关闭已打开的所有命令行窗口，然后同时按下 `Windows 键 + R 键`，输入 `cmd` 打开 `命令行提示符` 窗口，执行命令 `bash --version`，如果输出版本信息，则表示配置成功
+#### [其他常见问题请点击此处查看](HelpDoc.md)
 
 #### 项目内容