Skip to content

Commit

Permalink
add:添加README目录
Browse files Browse the repository at this point in the history
  • Loading branch information
GentleCP committed Sep 1, 2020
1 parent 5dcc758 commit 7ffd1f8
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,33 @@
![python version](https://img.shields.io/badge/python-3.5%2B-blue)
![demo version](https://img.shields.io/badge/version-2.0.1-yellowgreen)

目录
=================

* [前言](#前言)
* [1. 功能介绍](#1-功能介绍)
* [1.1 课程资源下载](#11-课程资源下载)
* [1.2 wifi登录](#12-wifi登录)
* [1.3 课程评估](#13-课程评估)
* [1.4 分数查询](#14-分数查询)
* [2. 更新日志](#2-更新日志)
* [3. 作者信息](#3-作者信息)
* [4. 效果预览](#4-效果预览)
* [5. 部署使用](#5-部署使用)
* [5.1 使用前提](#51-使用前提)
* [5.2 配置修改](#52-配置修改)
* [5.3 使用步骤](#53-使用步骤)
* [6. 问题反馈](#6-问题反馈)

# 前言
原本只是一时兴起,为了方便写的UCAS课程网站小助手,帮助我自己进行课程资源快速同步。
没想到后面随着功能的增加,项目也变得小有规模起来,因此将其开放给全体UCAS同学,小助手的使用方式在下面有介绍,
十分简便(需要一点对`python`环境的了解,百度`python`的安装即可),如果你觉得本项目对你有所帮助的话,
希望你能帮我点个star,算是对作者的一点激励吧~

> 注意:由于课程网站的变动可能引发脚本失效,在失效后,我会尽量及时修复bug,并更新版本到github,
建议star项目方便接收更新消息,或者在失效时查看本项目[github链接](https://github.com/GentleCP/UCASHelper)

# 1. 功能介绍
## 1.1 课程资源下载
国科大的课程网站在高校中已经算是很便利的了,老师可以发布ppt或其他课程资源到网站上,
Expand All @@ -21,7 +41,7 @@
## 1.2 wifi登录
提供了自动登录的功能,且允许添加多个账号,当一个账号流量使用完后,可用下一个账号自动登录,
每月自动更新。出于隐私保护,项目不直接提供爆破的账号密码信息(以防被外来人员利用),在校学生可通过执行`python manage.py hack`命令
每月自动更新。出于隐私保护,项目不直接提供爆破的账号密码信息(以防被外来人员利用),在校学生可参考**5.3使用步骤**
破解新的账号。
> 爆破需在校园网环境下,请确保你已正确连接校园网(建议有线)且未登录校园网。
爆破时间较长(慢的时候2-3个小时),因此建议晚上睡觉的时候开启,
Expand Down Expand Up @@ -80,7 +100,7 @@
![](img/1.5.0-1.png)
- 允许添加不希望被同步的课程内容:在同步所有的时候有一门课的资源并没什么卵用,但为了一门而去一个个同步其他的又略显麻烦,
因此添加了一个`FILTER_LIST`,存放不想被同步的课程目录。打开`settings.py`,找到`FILTER_LIST`
将不像被同步的课程全名(如`没啥用课19-20春季`),添加到列表当中,如下:
将不想被同步的课程全名(如`没啥用课19-20春季`),添加到列表当中,如下:
![](img/1.5.0-2.png)

- 新版本在同步更新完成后会自动退出,不需要再手动退出程序
Expand All @@ -95,13 +115,13 @@
- [1.4.1]
> 在课程资源选项中可以选择仅同步某个学期(春季,夏季,秋季)课程
# 3. 作者
# 3. 作者信息
- name: 董超鹏
- nickname: GentleCP
- e-mail: [email protected]
- website: https://www.gentlecp.com

# 4. 实现功能
# 4. 效果预览
- 小白使用窗口
![](img/2-1.png)
- 自动登录校园网
Expand All @@ -122,7 +142,7 @@
- 自动评估课程和教师
![](img/5-1.png)

# 5. 部署与使用
# 5. 部署使用

## 5.1 使用前提
项目采用python语言编写,需要你本地装有python3环境(建议python3.5+),如果采用`git`方式克隆,需先安装好`git`
Expand Down Expand Up @@ -166,7 +186,7 @@
pip install -r requirements.txt # 强烈建议使用虚拟环境
conda env create -f environment.yml # 如果采用conda环境
```
3. 自由选择`UI`界面操作或命令行直接运行,可通过`python ucashelper --help`获得参数帮助
3. 自由选择`UI`界面操作或命令行直接运行,可通过`python ucashelper.py --help`获得参数帮助
- UI界面运行
```text
python ucashelper.py ui
Expand Down Expand Up @@ -196,5 +216,5 @@
python ucashelper.py hack
```

# 6. 提问
# 6. 问题反馈
对项目如有任何问题或修改意见,欢迎提交`issue`或者邮件私信给我~

0 comments on commit 7ffd1f8

Please sign in to comment.