add requirements.txt

Author: archibate

.github/workflows/generate_release_pdf.yml

@@ -28,10 +28,7 @@ jobs:
 
       - name: Prepare Mkdocs environment
         run: |
-          pip install mkdocs
-          pip install mkdocs-print-site-plugin
-          pip install mkdocs-macros-plugin
-          pip install python-markdown-math
+          pip install -r requirements.txt
 
       - name: Compile Mkdocs document
         run: |

README.md

@@ -64,15 +64,20 @@
 
 本书使用 [Mkdocs](https://www.mkdocs.org/) 构建，是一种基于 Markdown 的静态网站生成器，可以把一堆 Markdown 文件编译成一个网站，非常适合用于写书。
 
+每当小彭老师提交新的代码，GitHub 的机器人就会自动调用 Mkdocs 重新编译和部署网页。这样，小彭老师只需要关心写作本书，不用再操心排版、发布等问题。
+
 ```bash
-pip install mkdocs mkdocs-print-site-plugin mkdocs-macros-plugin python-markdown-math
+git clone https://github.com/parallel101/cppguidebook
+cd cppguidebook
+pip install -r requirements.txt
 ```
 
-克隆本仓库后，可以用 `mkdocs build` 命令编译生成 `site` 文件夹，打开其中的 `site/index.html` 就可以开始看了。也可以用 `mkdocs serve` 命令，在 `http://127.0.0.1:8000` 开启实时预览服务，每当你修改 `.md` 文件时都会自动刷新。
+> [`requirements.txt`](requirements.txt) 中是包括 Mkdocs 在内的构建本书所需的全部依赖项。
 
-每当小彭老师提交新的代码，GitHub 的机器人就会自动调用 Mkdocs 重新编译和部署网页。这样，小彭老师只需要关心写作本书，不用再操心排版、发布等问题。
+- `mkdocs build` 命令可以编译生成 `site` 文件夹，打开其中的 `site/index.html` 就可以开始看了。
+- `mkdocs serve` 命令会在 `http://127.0.0.1:8000` 开启实时预览服务，在浏览器中打开该地址，每当你修改 `.md` 文件时页面都会自动刷新。
 
-> 以下是第一章节的内容预览，要查看全文，请前往 Release 页面下载完整 PDF 文件。
+> 以下是第一章节的内容预览，要查看全文，请前往 Release 页面下载完整 PDF 文件或[在线浏览](https://parallel101.github.io/cppguidebook)。
 
 # 前言
 

requirements.txt

@@ -0,0 +1,4 @@
+mkdocs
+mkdocs-print-site-plugin
+mkdocs-macros-plugin
+python-markdown-math