Update: Add examples for aliases, links for licenses

LussacZheng · Aug 10, 2020 · ea6b526 · ea6b526
1 parent 4d952db
commit ea6b526
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 ![GitHub repo size](https://img.shields.io/github/repo-size/LussacZheng/video-downloader-deploy?logo=github)
 ![version](https://img.shields.io/github/package-json/v/LussacZheng/video-downloader-deploy_info?color=important)
 
-快速配置和使用 **[You-Get](https://github.com/soimort/you-get) , [Youtube-dl](https://github.com/ytdl-org/youtube-dl) , [Annie](https://github.com/iawia002/annie) , 和 [FFmpeg](https://ffmpeg.org)** 的一键配置脚本。
+快速配置和使用 **[You-Get][you-get] , [Youtube-dl][youtube-dl] , [Annie][annie] , 和 [FFmpeg][ffmpeg]** 的一键配置脚本。
 
 - 无需安装 Python ，一键配置绿色便携版的 you-get , youtube-dl 。
 - 此绿色版基于 Python 的 embeddable 版。
@@ -40,6 +40,17 @@
 
 > 在新增自定义别名之前，不妨先尝试 `导入默认别名` ，然后打开启动脚本 `下载视频.bat` ，输入 `open` 并执行。
 
+列举几个可能比较常用的别名作为参考：
+
+| 别名                                                  | 作用                                                 |
+| :---------------------------------------------------- | :--------------------------------------------------- |
+| open = `explorer .\`                                  | 打开当前目录，即 `Download` 文件夹                   |
+| yb = `youtube-dl -f bestvideo+bestaudio`              | 使用 youtube-dl 下载最佳清晰度                       |
+| yf = `youtube-dl --proxy socks5://127.0.0.1:10808 -F` | 使用 youtube-dl 查看所有可下载的清晰度，同时启用代理 |
+| ac = `annie -c cookies.txt`                           | 使用 annie 下载并加载 cookies 文件                   |
+| ygc = `you-get -c cookies.txt`                        | 使用 you-get 下载并加载 cookies 文件                 |
+| ...                                                   | ...                                                  |
+
 **注意**：自定义别名的命名，最好是英文字母、数字的组合。尽管可以包含横杠、下划线、或中文，但其至少应符合正则表达式 `^[\w\-\u4e00-\u9fa5]+$` ，尤其不应含有空格和上文提及的特殊符号。另外，别名切忌与命令相同，否则会导致无限循环调用。
 
 ---
@@ -90,11 +101,35 @@ git pull
 - `get-pip.py`
 
   ```
-  Version:    v19.2.2 (pip)
+  Version:    v19.2.2 (pip for bootstrap)
   MD5:        7f66b79bf181521f6851a75848aad8b2
   Source:     https://bootstrap.pypa.io/get-pip.py
   ```
 
+### License
+
+|            Project             |                 License                 |
+| :----------------------------: | :-------------------------------------: |
+|       [you-get][you-get]       |     [MIT License][you-get license]      |
+|    [youtube-dl][youtube-dl]    |   [The Unlicense][youtube-dl license]   |
+|         [annie][annie]         |      [MIT License][annie license]       |
+| [FFmpeg Builds][ffmpeg builds] |    [GPL 3.0][ffmpeg builds license]     |
+|        [Python][python]        | [PSF LICENSE AGREEMENT][python license] |
+
 ### 更多信息
 
 查阅 [Wiki](https://github.com/LussacZheng/video-downloader-deploy/wiki) 以了解更多信息。
+
+<!-- Reference Links -->
+
+[you-get]: https://github.com/soimort/you-get
+[you-get license]: https://github.com/soimort/you-get/blob/develop/LICENSE.txt
+[youtube-dl]: https://github.com/ytdl-org/youtube-dl
+[youtube-dl license]: https://github.com/ytdl-org/youtube-dl/blob/master/LICENSE
+[annie]: https://github.com/iawia002/annie
+[annie license]: https://github.com/iawia002/annie/blob/master/LICENSE
+[ffmpeg]: https://ffmpeg.org
+[ffmpeg builds]: https://ffmpeg.zeranoe.com/builds/
+[ffmpeg builds license]: http://www.gnu.org/licenses/gpl-3.0.html
+[python]: https://www.python.org
+[python license]: https://docs.python.org/3.7/license.html#terms-and-conditions-for-accessing-or-otherwise-using-python
diff --git a/README_en.md b/README_en.md
@@ -7,7 +7,7 @@
 ![GitHub repo size](https://img.shields.io/github/repo-size/LussacZheng/video-downloader-deploy?logo=github)
 ![version](https://img.shields.io/github/package-json/v/LussacZheng/video-downloader-deploy_info?color=important)
 
-A One-Click batch for the deployment and quickstart of **[You-Get](https://github.com/soimort/you-get) , [Youtube-dl](https://github.com/ytdl-org/youtube-dl) , [Annie](https://github.com/iawia002/annie) , and [FFmpeg](https://ffmpeg.org)** .
+A One-Click batch script for the deployment and quickstart of **[You-Get][you-get] , [Youtube-dl][youtube-dl] , [Annie][annie] , and [FFmpeg][ffmpeg]** .
 
 - No need to install Python, one-click to deploy a portable version of you-get, youtube-dl.
 - This portable deployment is based on the embeddable version of Python.
@@ -43,6 +43,17 @@ Run `Deploy.bat` and select `Aliases Management` to add customize aliases.
 
 > Before adding a custom alias, please try `Import default alias`. Then start the `Download_Video.bat`, input `open` and ENTER.
 
+Take several aliases, which might be commonly used, as examples and references:
+
+| Alias                                    | Function                                                         |
+| :--------------------------------------- | :--------------------------------------------------------------- |
+| open = `explorer .\`                     | Open the current directory, which is `Download\`                 |
+| yb = `youtube-dl -f bestvideo+bestaudio` | Use youtube-dl to download the video of best quality             |
+| yf = `youtube-dl -F`                     | Use youtube-dl to list all available formats of requested videos |
+| ac = `annie -c cookies.txt`              | Use annie to download, with cookies loaded                       |
+| ygc = `you-get -c cookies.txt`           | Use you-get to download, with cookies loaded                     |
+| ...                                      | ...                                                              |
+
 **Notice**: The name of customize alias is preferably a combination of letters, numbers, dashes and/or underscores. It should macth the RegExp `^[\w\-]+$`, and particularly no whitespace or the special punctuations mentioned above. In addition, the alias must NOT be the same as the command, otherwise it will cause an endless loop.
 
 ---
@@ -87,11 +98,35 @@ git pull
 - `get-pip.py`
 
   ```
-  Version:    v19.2.2 (pip)
+  Version:    v19.2.2 (pip for bootstrap)
   MD5:        7f66b79bf181521f6851a75848aad8b2
   Source:     https://bootstrap.pypa.io/get-pip.py
   ```
 
+### License
+
+|            Project             |                 License                 |
+| :----------------------------: | :-------------------------------------: |
+|       [you-get][you-get]       |     [MIT License][you-get license]      |
+|    [youtube-dl][youtube-dl]    |   [The Unlicense][youtube-dl license]   |
+|         [annie][annie]         |      [MIT License][annie license]       |
+| [FFmpeg Builds][ffmpeg builds] |    [GPL 3.0][ffmpeg builds license]     |
+|        [Python][python]        | [PSF LICENSE AGREEMENT][python license] |
+
 ### More information
 
 Check [Wiki](https://github.com/LussacZheng/video-downloader-deploy/wiki) for more information.
+
+<!-- Reference Links -->
+
+[you-get]: https://github.com/soimort/you-get
+[you-get license]: https://github.com/soimort/you-get/blob/develop/LICENSE.txt
+[youtube-dl]: https://github.com/ytdl-org/youtube-dl
+[youtube-dl license]: https://github.com/ytdl-org/youtube-dl/blob/master/LICENSE
+[annie]: https://github.com/iawia002/annie
+[annie license]: https://github.com/iawia002/annie/blob/master/LICENSE
+[ffmpeg]: https://ffmpeg.org
+[ffmpeg builds]: https://ffmpeg.zeranoe.com/builds/
+[ffmpeg builds license]: http://www.gnu.org/licenses/gpl-3.0.html
+[python]: https://www.python.org
+[python license]: https://docs.python.org/3.7/license.html#terms-and-conditions-for-accessing-or-otherwise-using-python