From 8c9d50fc75ad3cbae05648b98d846e1e83d8311f Mon Sep 17 00:00:00 2001 From: Zain <49631199+ZainCheung@users.noreply.github.com> Date: Sat, 27 Jun 2020 15:18:38 +0800 Subject: [PATCH] Update README.md --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index e2420f4..bfd5a82 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,20 @@ git clone https://github.com/ZainCheung/netease-cloud.git ### 安装依赖 +> 需要安装的依赖目前只有一个`request`,如果运行报错缺少什么模块就给什么模块加进`requirements.txt`中 + ```bash pip install -r requirements.txt ``` +### 启动程序 + +> 程序需要`python3`的运行环境,如果没有请自行下载安装配置 + +``` +python main.py +``` + ### 配置账号 > 为了保护账号信息,所有的账号密匙都打上了*号,使用时请换成自己的账号 @@ -65,6 +75,10 @@ pip install -r requirements.txt 第一句注释是为了声明编码格式,请不要删除该行注释 +------ + + + #### 账号 ```bash @@ -82,6 +96,10 @@ password = bfa834f7de58cb650ca01edb******** > 注意,这里密码填写类型与后面的md5开关相关联,具体见后面介绍 +------ + + + #### 设置 ```bash @@ -95,6 +113,13 @@ api是指提供接口的服务器地址,这里提供一个Demo,源码也已 另外想快速拥有一个一模一样的api服务并且使用自己定义的域名,那么可以按照上面项目的教程自己快速搭建 +------ + + + +##### MD5 + + ```bash # 密码是否需要MD5加密,如果是明文密码一定要打开 # true 需要, 则直接将你的密码(明文)填入password,程序会替你进行加密 @@ -104,6 +129,12 @@ md5Switch = false md5开关,如果自己不会加密md5,那么将这个开关置为true,并且将你的密码(明文)填入password,程序会为你加密。如果已经知道密码的md5,则将这个开关置为false,将md5填入上面的password内 +------ + + + +##### 多账号 + ```bash # 是否开启多账号功能,如果打开将会忽视配置文件里的账号而从account.json中寻找账号信息 # 如果选择使用多账号,请配置好account里的账号和密码,即account和password,而sckey不是必需的,如果为空则不会进行微信推送 @@ -113,6 +144,12 @@ peopleSwitch = false 这个开关是为那些拥有多账号或者准备带朋友一起使用的朋友准备的,正如注释所说,如果你有多个账号,都想使用这个服务,那么可以打开`peopleSwitch`置为true,那么配置文件里的账号就会被程序忽略,直接读取`account.json`中的账号信息,关于`account.json`的配置在后面。 +------ + + + +##### 微信提醒 + ```bash # Server酱的密匙,不需要推送就留空,密匙的免费申请参考:http://sc.ftqq.com/ sckey = SCU97783T70c13167b4daa422f4d419a765eb4ebb5ebc9******** @@ -120,6 +157,10 @@ sckey = SCU97783T70c13167b4daa422f4d419a765eb4ebb5ebc9******** Server酱,是一个可以向你的微信推送消息的服务,并且消息内容完全自定义,使用之前只需要前往官网,使用GitHub登陆,扫码绑定微信,便可以获得密匙,从此免费使用Server酱 +------ + + + ### 配置多账号 第一次打开`account.json`,内容会是这样 @@ -160,6 +201,10 @@ Server酱,是一个可以向你的微信推送消息的服务,并且消息 可见这里的`sckey`为空,那么完成任务后便不会发送消息提醒,如果不确定是否成功可以查看日志 +------ + + + ## 日志 程序运行中生成的所有记录都会保存在日志文件中,第一次克隆项目时,不会看到`run.log`日志文件,而在程序第一次运行时才会生成 -- GitLab