Update README.md and add requirements-dev.txt

README.md

@@ -49,6 +49,9 @@ Issue、PR、纠错、资料、选课/考试攻略，完全欢迎！
 
 来自大家的关注、维护和贡献，才是让这个浙江大学独有的攻略本继续存在的动力~
 
+<details>
+  <summary>操作方法</summary>
+
 提交 PR：Fork 本项目，然后在 GitHub 网页端点击 Upload File 上传文件，发起 PR 即可。留意一下项目的文件组织喔。
 
 或者也可以直接附加在 Issue 中，由维护者进行添加。
@@ -63,14 +66,14 @@ Issue、PR、纠错、资料、选课/考试攻略，完全欢迎！
 
 2. 上传文件到新文件夹：打开任意文件夹，点击绿色Download按钮旁的upload，**把浏览器地址栏中文件夹名称改为你想要新建的文件夹名称，然后回车**，上传你的文件。
 
-## 提醒
+### 提醒
 
 有些朋友在提交 PR 的时候可能会注意到自己的 Fork 和我们的主分支有数十甚至上百个不同的 commit 。如果出现这种情况，可以考虑以下两种解决方案：
 
 1. 如果对git不太熟悉，建议（在备份完成后）先删除你的项目，重新 fork 、上传并重新提交 PR 。
 2. 如果对git及其工作原理较为熟悉（而且愿意花费时间和流量折腾），可以尝试在 fork 出的项目上进行 rebase 以消除与主分支在历史上的冲突。
 
-## 警告
+### 警告
 
 下列内容为不适合上传的内容。如果你认为缺少这些资料将会影响资源的完整性，请优先考虑放在校内资源平台，或联系你的教师并由教师发布。建议你撰写一个 README 文档并放置一些链接或指引文字来帮助找到这些资源。
 
@@ -80,6 +83,8 @@ Issue、PR、纠错、资料、选课/考试攻略，完全欢迎！
 
 如果你认为本仓库的一些文件侵犯了您的权益，请 [向我们发送邮件](mailto:[email protected]) 。我们将会从仓库中彻底清除这些文件。
 
+</details>
+
 ## 许可
 
 由贡献者编写部分的许可如下：

docs/index.md

@@ -49,6 +49,9 @@ Issue、PR、纠错、资料、选课/考试攻略，完全欢迎！
 
 来自大家的关注、维护和贡献，才是让这个浙江大学独有的攻略本继续存在的动力~
 
+<details>
+  <summary>操作方法</summary>
+
 提交 PR：Fork 本项目，然后在 GitHub 网页端点击 Upload File 上传文件，发起 PR 即可。留意一下项目的文件组织喔。
 
 或者也可以直接附加在 Issue 中，由维护者进行添加。
@@ -63,6 +66,25 @@ Issue、PR、纠错、资料、选课/考试攻略，完全欢迎！
 
 2. 上传文件到新文件夹：打开任意文件夹，点击绿色Download按钮旁的upload，**把浏览器地址栏中文件夹名称改为你想要新建的文件夹名称，然后回车**，上传你的文件。
 
+### 提醒
+
+有些朋友在提交 PR 的时候可能会注意到自己的 Fork 和我们的主分支有数十甚至上百个不同的 commit 。如果出现这种情况，可以考虑以下两种解决方案：
+
+1. 如果对git不太熟悉，建议（在备份完成后）先删除你的项目，重新 fork 、上传并重新提交 PR 。
+2. 如果对git及其工作原理较为熟悉（而且愿意花费时间和流量折腾），可以尝试在 fork 出的项目上进行 rebase 以消除与主分支在历史上的冲突。
+
+### 警告
+
+下列内容为不适合上传的内容。如果你认为缺少这些资料将会影响资源的完整性，请优先考虑放在校内资源平台，或联系你的教师并由教师发布。建议你撰写一个 README 文档并放置一些链接或指引文字来帮助找到这些资源。
+
+- 盗版电子书/付费电子书
+- 盗版/破解版/绿色版付费软件及其安装包
+- 课程/教师主页上列出的内容（请在获得教师许可后上传）
+
+如果你认为本仓库的一些文件侵犯了您的权益，请 [向我们发送邮件](mailto:[email protected]) 。我们将会从仓库中彻底清除这些文件。
+
+</details>
+
 ## 许可
 
 由贡献者编写部分的许可如下：

requirements-dev.txt

@@ -0,0 +1,2 @@
+autopep8
+pylint

update.py

@@ -24,10 +24,10 @@ def list_files(course: str):
             if f not in README_MD:
                 if f.split('.')[-1] in TXT_EXTS:
                     filelist_texts += '{}- [{}]({})\n'.format(subindent,
-                                                              f, '{}{}/{}'.format(TXT_URL_PREFIX, root,  f))
+                                                              f, '{}{}/{}'.format(TXT_URL_PREFIX, root, f))
                 else:
                     filelist_texts += '{}- [{}]({})\n'.format(subindent,
-                                                              f, '{}{}/{}'.format(BIN_URL_PREFIX, root,  f))
+                                                              f, '{}{}/{}'.format(BIN_URL_PREFIX, root, f))
             else:
                 readme_path = '{}/{}'.format(root, f)
     return filelist_texts, readme_path
@@ -49,3 +49,9 @@ def generate_md(course: str, filelist_texts: str, readme_path: str):
     for course in courses:
         filelist_texts, readme_path = list_files(course)
         generate_md(course, filelist_texts, readme_path)
+
+    with open('README.md', 'r') as file:
+        mainreadme_lines = file.readlines()
+
+    with open('docs/index.md', 'w') as file:
+        file.writelines(mainreadme_lines)