diff --git a/docs/tutorial-EN.md b/docs/tutorial-EN.md index 9ec3d3f3f9..2e0b63d3df 100644 --- a/docs/tutorial-EN.md +++ b/docs/tutorial-EN.md @@ -76,11 +76,11 @@ Adjust the configuration as needed. Below is the default configuration explanati ### 1. Install Python -Please download and install Python from the official website. +Please download and install Python from the official website, and choose to add Python to the system environment variable Path during installation. ### 2. Run the Update -Run the following commands in the terminal under the project directory: +Open the terminal CMD under the project directory and run the following commands in order: ```python pip3 install pipenv @@ -113,7 +113,7 @@ Follow this project to be notified by email about the latest updates and release Return to the homepage of your repository. If there are updates to the project, click on "Sync fork" and then "Update branch" to confirm and update to the latest code. ![Sync-fork](./images/sync-fork.png 'Sync fork') -

Please use the following content with caution. If you have a large number of channels that need to be updated, please use local updates instead of automatic updates. Improper configuration may lead to your account or workflow being banned!

+## Please use the following content with caution. If you have a large number of channels that need to be updated, please use local updates instead of automatic updates. Improper configuration may lead to your account or workflow being banned! ## Step 6: Enable Auto-update (Only suitable for a small number of channel updates) @@ -175,9 +175,6 @@ If you can access this link and it returns the updated interface content, then y ![.github/workflows/main.yml](./images/schedule-cron.png '.github/workflows/main.yml') If you want to modify the update frequency (default: daily at 8:00 am Beijing time), you can modify the on:schedule:- cron field. -

-1. It is strongly discouraged to make modifications, as there is no difference in the content of the interface in a short period of time. Both too frequent updates and high-consumption running workflows may be judged as resource abuse, leading to the risk of the repository and account being banned. -

-

-2. Please pay attention to the runtime of your workflow. If you find that the execution time is too long, you need to appropriately reduce the number of channels in the template, modify the number of pages and interfaces in the configuration, in order to meet the compliant operation requirements. -

+### 1. It is strongly discouraged to make modifications, as there is no difference in the content of the interface in a short period of time. Both too frequent updates and high-consumption running workflows may be judged as resource abuse, leading to the risk of the repository and account being banned. + +### 2. Please pay attention to the runtime of your workflow. If you find that the execution time is too long, you need to appropriately reduce the number of channels in the template, modify the number of pages and interfaces in the configuration, in order to meet the compliant operation requirements. diff --git a/docs/tutorial.md b/docs/tutorial.md index 91369bb86b..a52c16f4ab 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -75,11 +75,11 @@ ### 1. 安装 Python -请至官方下载并安装 Python +请至官方下载并安装 Python，安装时请选择将 Python 添加到系统环境变量 Path 中 ### 2. 运行更新 -项目目录下终端运行以下命令： +项目目录下打开终端 CMD 依次运行以下命令： ```python pip3 install pipenv @@ -112,7 +112,7 @@ https://mirror.ghproxy.com/raw.githubusercontent.com/您的github用户名/仓 回到您的仓库首页，如果项目有更新内容，点击 Sync fork，Update branch 确认即可更新最新代码 ![Sync-fork](./images/sync-fork.png 'Sync fork') -

以下内容请谨慎使用，如果您有大量的频道需要更新，请使用本地更新，勿使用自动更新，配置不当可能导致账户或工作流封禁！

+## 以下内容请谨慎使用，如果您有大量的频道需要更新，请使用本地更新，勿使用自动更新，配置不当可能导致账户或工作流封禁！ ## 步骤六：开启自动更新（仅适合少量频道更新） @@ -174,9 +174,6 @@ https://mirror.ghproxy.com/raw.githubusercontent.com/您的github用户名/仓 ![.github/workflows/main.yml](./images/schedule-cron.png '.github/workflows/main.yml') 如果您想修改更新频率（默认北京时间每日 8:00），可修改 on:schedule:- cron 字段。 -

-1. 强烈不建议修改，因为短时间内的接口内容并无差异，过高的更新频率与高耗时运行的工作流都有可能被判定为资源滥用，导致仓库与账户被封禁的风险。 -

-

-2. 请留意您的工作流运行时长，若发现执行时间过长，需要适当删减模板中频道数量、修改配置中的分页数量和接口数量，以达到合规的运行要求。 -

+### 1. 强烈不建议修改，因为短时间内的接口内容并无差异，过高的更新频率与高耗时运行的工作流都有可能被判定为资源滥用，导致仓库与账户被封禁的风险。 + +### 2. 请留意您的工作流运行时长，若发现执行时间过长，需要适当删减模板中频道数量、修改配置中的分页数量和接口数量，以达到合规的运行要求。