README: 20211106

README.md

@@ -1,31 +1,33 @@
-# OpenWrt with AutoUpdate
+# OpenWrt-Actions & One-key AutoUpdate
 
 ![GitHub Stars](https://img.shields.io/github/stars/Hyy2001X/AutoBuild-Actions.svg?style=flat-square&label=Stars&logo=github)
 ![GitHub Forks](https://img.shields.io/github/forks/Hyy2001X/AutoBuild-Actions.svg?style=flat-square&label=Forks&logo=github)
 
 AutoBuild-Actions 稳定版/模板地址: [AutoBuild-Actions-Template](https://github.com/Hyy2001X/AutoBuild-Actions-Template)
 
-自用软件包地址: [AutoBuild-Packages](https://github.com/Hyy2001X/AutoBuild-Packages)
+自用修改版软件包地址: [AutoBuild-Packages](https://github.com/Hyy2001X/AutoBuild-Packages)
 
 支持的 OpenWrt 源码: `coolsnowwolf/lede`、`immortalwrt/immortalwrt`、`openwrt/openwrt`、`lienol/openwrt`
 
-## 一、定制固件(可选,可直接开始编译)
+❗**为了你的账号安全, 请不要使用 SSH 连接 Github Action**, `.config`配置等操作请在本地完成
+
+## 一、定制固件(可选)
 
 1. 进入你的`AutoBuild-Actions`仓库, **下方所有操作都将在你的`AutoBuild-Actions`仓库下进行**
 
    建议使用`Github Desktop`和`Notepad++`进行操作 [[Github Desktop](https://desktop.github.com/)] [[Notepad++](https://notepad-plus-plus.org/downloads/)]
 
-   **提示**: 下文的**TARGET_PROFILE**为设备名称,可以在本地的`.config`中获取,例如: `d-team_newifi-d2`、`asus_rt-acrh17`
+   **提示**: 文中的 **TARGET_PROFILE** 均为你要编译的设备的设备名称, 例如: `d-team_newifi-d2`、`asus_rt-acrh17`
 
-   本地获取,在源码目录执行`egrep -o "CONFIG_TARGET.*DEVICE.*=y" .config | sed -r 's/.*DEVICE_(.*)=y/\1/'`
+   从本地获取: 在源码目录执行`egrep -o "CONFIG_TARGET.*DEVICE.*=y" .config | sed -r 's/.*DEVICE_(.*)=y/\1/'`
    
-   或`grep 'TARGET_PROFILE' .config`
+   或执行`grep 'TARGET_PROFILE' .config`, 请先执行`make menuconfig`进行配置
 
-2. 编译`/Configs`目录中对应的配置文件,若设备配置不存在则需要把本地的`.config`文件**重命名**并上传
+2. 编译`/Configs`目录下的配置文件, 若该设备的配置文件不存在则需要把本地的`.config`文件重命名为 **TARGET_PROFILE** 值并上传
 
-3. 编辑`/.github/workflows/*.yml`文件,修改`第 7 行`为易于自己识别的名称
+3. 编辑`/.github/workflows/*.yml`文件, 修改`第 7 行`为易于识别的设备名称
 
-4. 编辑`/.github/workflows/*.yml`文件,修改`第 32 行`为上传的`.config`文件名称
+4. 编辑`/.github/workflows/*.yml`文件, 修改`第 32 行`为 **TARGET_PROFILE** 值
 
 5. 按照需求且编辑`/Scripts/AutoBuild_DiyScript.sh`文件即可, `/Scripts`下的其他文件可以都不用修改
 
@@ -37,11 +39,11 @@ AutoBuild-Actions 稳定版/模板地址: [AutoBuild-Actions-Template](https://g
    
    Banner_Title Banner 标题,与作者名称一同在 Shell 展示
 
-   * Default_LAN_IP 固件默认 LAN IP 地址
+   * Default_LAN_IP 固件 IP 地址
 
-   Short_Firmware_Date 简短的固件日期 true: [20210601]; false: [202106012359]
+   Short_Firmware_Date 启用简短的固件日期 true: [20210601]; false: [202106012359]
    
-   * Load_Common_Config 通用配置文件/Configs/Common,将被追加到当前设备的配置文件中
+   * Load_Common_Config 位于 /Configs/Common 的通用配置文件, 将被追加到当前设备的配置文件中
 
    * Load_CustomPackages_List 启用后, 将运行 /Scripts/AutoBuild_ExtraPackages.sh 脚本
 
@@ -49,11 +51,11 @@ AutoBuild-Actions 稳定版/模板地址: [AutoBuild-Actions-Template](https://g
    
    Firmware_Format 自定义固件格式, 多个格式请用空格隔开
 
-   REGEX_Skip_Checkout 固件检测屏蔽正则列表,用于过滤无用文件
+   REGEX_Skip_Checkout 固件目录无用文件屏蔽正则表达式
 
    * INCLUDE_AutoBuild_Features 自动添加 AutoBuild 固件特性, 例如: 一键更新、部分优化
 
-   * INCLUDE_DRM_I915 自动启用 x86 设备的 Intel Graphics i915 驱动
+   * INCLUDE_DRM_I915 自动启用 x86 设备的 Intel Graphics 显卡驱动
 
    INCLUDE_Argon 自动添加 luci-theme-argon 主题和主题控制器
 
@@ -61,14 +63,14 @@ AutoBuild-Actions 稳定版/模板地址: [AutoBuild-Actions-Template](https://g
    
    注: 禁用部分功能请将变量值修改为 false, 开启则为 true
    
-   带 * 符号的选项表示仅在 coolsnowwolf/lede 源码测试通过,这表示可能在其他源码不能友好地运行
+   带 * 符号的选项表示仅在 coolsnowwolf/lede 源码测试通过
 ```
 
-## 二、编译固件
+## 二、编译固件(必选)
 
    **手动编译** 点击上方`Actions`, 在左栏选择要编译的设备,点击右方`Run workflow`再点击绿色按钮即可开始编译
 
-   **一键编译** 删除`第 26-27 行`的注释并保存,单(双)击重新点亮右上角的 **Star** 即可一键编译
+   **一键编译** 删除`第 26-27 行`的注释并保存, 触发点亮右上角的 **Star** 按钮即可一键编译
 
    **定时编译** 删除`第 23-24 行`的注释, 然后按需修改时间并提交修改 [Corn 使用方法](https://www.runoob.com/w3cnote/linux-crontab-tasks.html)
 
@@ -82,13 +84,13 @@ AutoBuild-Actions 稳定版/模板地址: [AutoBuild-Actions-Template](https://g
 
 3. 上传修改后的`Update_Logs.json`到你仓库的`Release`
 
-## 使用 AutoUpdate 一键更新固件脚本
+## 使用一键更新固件脚本
 
    首先需要打开`TTYD 终端`或者使用`SSH`, 按需输入下方指令:
 
    更新固件: `autoupdate`或`bash /bin/AutoUpdate.sh`
 
-   更新固件(镜像加速 Ghproxy | FastGit): `autoupdate -P <G | F>`
+   使用镜像加速更新固件: `autoupdate -P`
 
    更新固件(不保留配置): `autoupdate -n`
    
@@ -96,6 +98,10 @@ AutoBuild-Actions 稳定版/模板地址: [AutoBuild-Actions-Template](https://g
    
    "我不管, 我就是要更新!": `autoupdate -f`
 
+   更新脚本: `autoupdate -x`
+
+   列出相关信息: `autoupdate --list`
+
    查看所有可用参数: `autoupdate --help`
 
    **注意: **部分参数可一起使用, 例如: `autoupdate -n -P G -F --skip --path /mnt/sda1`
@@ -125,6 +131,6 @@ AutoBuild-Actions 稳定版/模板地址: [AutoBuild-Actions-Template](https://g
 
    - [eSir 's workflow template](https://github.com/esirplayground/AutoBuild-OpenWrt/blob/master/.github/workflows/Build_OP_x86_64.yml)
    
-   - 灵感来源/Based on: [openwrt-autoupdate](https://github.com/mab-wien/openwrt-autoupdate) [Actions-OpenWrt](https://github.com/P3TERX/Actions-OpenWrt)
+   - [[openwrt-autoupdate](https://github.com/mab-wien/openwrt-autoupdate)] [[Actions-OpenWrt](https://github.com/P3TERX/Actions-OpenWrt)]
 
    - 测试与建议: [CurssedCoffin](https://github.com/CurssedCoffin) [Licsber](https://github.com/Licsber) [sirliu](https://github.com/sirliu) [神雕](https://github.com/teasiu) [yehaku](https://www.right.com.cn/forum/space-uid-28062.html) [缘空空](https://github.com/NaiHeKK) [281677160](https://github.com/281677160)