WooooDyy/postgraduate-recommendation

保研攻略

保研攻略

地址：https://postgraduate-recommendation.readthedocs.io/zh_CN/latest/

由南大软院学长学姐编写的保研攻略，希望大家都能更快更高效更少踩坑地成功保研，拥有光明的未来。

贡献

构建

本项目使用pipenv管理pip依赖，请安装：

• Python 3
• pipenv
  • pip install --user pipenv (Windows下已测试)
  • 若上命令不可用，请参考官方教程

本项目使用reStructuredText进行写作，请学习它。

本项目使用sphinx进行文档生成，如果需要学习对项目进行修改，请查看sphinx的文档。

1. Clone本项目
2. pipenv install安装依赖
3. pipenv shell进入虚拟环境
4. .\make html (Windows)、make html（安装了make的*nix）构建文档HTML
5. 使用浏览器打开build/html/index.html，即可预览已经产生的文档！

Tips

• 目前暂时没看到一个能用的支持中文的reST表格生成器，请使用VSCode的Table Formatter插件进行表格的格式化

• 要在VSCode里预览，请在VSCode里选择Python解释器为带有pipenv字样的那项，但此操作需要修改.vscode/settings.json文件，不要把它提交上来！

• 要从命令行里快速用浏览器打开生成的界面，可以使用如下两个命令：

  • start build/html/index.html（Windows）
  • open build/html/index.html（*nix）

• 插入本地图片可用如下语法�：

  • .. image:: ../assets/test.png

贡献

您可以用如下两种方式对此项目进行贡献：

• fork项目之后发PR
• 联系Chen Junda (GitHub)获取本项目写权限后，往本项目中非master分支提交您的内容，再发PR

在GitHub中本项目使用all-contributors维护贡献者列表。在PR即将被合并时，管理员将会使用all-contributors bot将您加入贡献者列表中。

在文档中手工维护，若您是第一次贡献本项目，并希望将自己的个人信息写在文档中，请进行以下步骤（若您不想加入，则可以什么都不做）：

• 在sources/authors.rst中，根据已有的格式加入您的个人信息
• 在您所修改过的文件的最后作者段中，使用以下格式加入到自己个人信息的链接。您的姓名要与authors.rst中您的姓名相对应。
  • 项目提供了内置的VSCode的code snippet用来输入这个信息，输入authorref即可自动输入此code snippet

:ref:`authors:已有的用户1` :ref:`authors:已有的用户2` :ref:`authors:您的姓名` 

贡献者 ✨

本项目不能离开各位慷慨的贡献者们！ (emoji key):

exlaw 🤔 🖋 👀	Chen Junda 🚇 🖋 👀	vivian 🖋	Tony Wang 🖋	zhanglingzhe0820 🖋	韩新虎 🖋	Wen Sun 🖋
Yuhao Xue 🖋	Charlie_Young 🖋	Alan Choo 🖋	羊男 🖋 👀	Wenqi Zhao 🖋	ZhangHongYin 🖋	Rongxin Cheng 🖋
xidao4 🖋	Chen YZ 🖋	LLY 🖋	caposerenity 🖋	garyGlh 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!

许可证

本项目所有文本内容在CC BY-NC-SA 4.0下授权。