From 54c05e632780ab243a64e64246ccc364f5c67d4e Mon Sep 17 00:00:00 2001 From: lyon Date: Tue, 25 Jan 2022 15:23:33 +0800 Subject: [PATCH 1/2] format readme --- README.md | 43 ++++++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b8c04f9..8ad4f90 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ # github_download_tools #### 介绍 -简单的github下载脚本，本质是使用python递归换源，可以使用它下载子模块 -本脚本只依赖标准python库，无需安装其它的库 +简单的 github 下载脚本，本质是使用 python 递归换源，可以使用它下载子模块 +本脚本只依赖标准 python 库，无需安装其它的库 #### 安装教程 -1. 下载并安装python -2. 下载并安装git +1. 下载并安装 python +2. 下载并安装 git 3. 下载本脚本 -4. 调用指令下载github库 +4. 调用指令下载 github库 5. 移动库到自己想要存放的地方 #### 使用说明 1. 打开帮助 -python gdt.py -h【或者python gdt.py --help】 + +```shell +python gdt.py -h +#或者 python gdt.py --help +``` + ```shell > python gdt.py -h made by sky kirto @@ -39,31 +44,43 @@ optional arguments: -v, --version tools version ``` -2. 下载不带子模块的github库 +2. 下载不带子模块的 github 库 +``` shell python gdt.py https://github.com/espressif/esp-idf.git +``` -3. 下载带子模块的github库 +3. 下载带子模块的 github 库 +``` shell python gdt.py https://github.com/espressif/esp-idf.git -s +``` -4. 下载带子模块的github库的指定分支 +4. 下载带子模块的 github 库的指定分支 +``` shell python gdt.py https://github.com/espressif/esp-idf.git -b release/v4.3 +``` -5. 下载github库并重命名 +5. 下载 github 库并重命名 +``` shell python gdt.py https://github.com/espressif/esp-idf.git -n esp_idf +``` -6. 下载github库并指定镜像 +6. 下载 github 库并指定镜像 +``` shell python gdt.py https://github.com/espressif/esp-idf.git -m https://github.com.cnpmjs.org/ +``` -也可以通过修改代码中的mirror_num指定列表__mirror__中的镜像源 +也可以通过修改代码中的 mirror_num 指定列表 __mirror__ 中的镜像源 7. 获取脚本的版本 -python gdt.py -v 【或者python gdt.py --version】 +``` shell +python gdt.py -v #或者python gdt.py --version +``` ```shell made by sky kirto -- Gitee From 63dc5bdb32e9e77415ed7ac920fac0d03d518191 Mon Sep 17 00:00:00 2001 From: lyon Date: Tue, 25 Jan 2022 15:28:21 +0800 Subject: [PATCH 2/2] fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ad4f90..25996d5 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ python gdt.py https://github.com/espressif/esp-idf.git -n esp_idf python gdt.py https://github.com/espressif/esp-idf.git -m https://github.com.cnpmjs.org/ ``` -也可以通过修改代码中的 mirror_num 指定列表 __mirror__ 中的镜像源 +也可以通过修改代码中的 `mirror_num` 指定列表 `__mirror__` 中的镜像源 7. 获取脚本的版本 -- Gitee