完善文档

This commit is contained in:
shitao 2020-12-15 19:08:48 +08:00
parent ac76c5703c
commit 758c7e732c
7 changed files with 63 additions and 42 deletions

3
.gitignore vendored
View File

@ -129,4 +129,5 @@ dmypy.json
# Pyre type checker
.pyre/
.idea
.idea
config.json

View File

@ -46,26 +46,23 @@
## 使用方法
### 方法一: 本地使用
> 不同的使用方法都需要参考配置说明,请详细阅读[【配置说明文档】](https://github.com/Sitoi/dailycheckin/blob/main/docs/settings.md)
参考教程: [本地使用教程](./docs/local.md)
> 不同的使用方法都需要参考配置说明,请详细阅读[【配置说明文档】](https://github.com/Sitoi/dailycheckin/blob/main/docs/settings.md)
### 方法二: Docker 使用
> 不同的使用方法都需要参考配置说明,请详细阅读[【配置说明文档】](https://github.com/Sitoi/dailycheckin/blob/main/docs/settings.md)
参考教程: [Docker 使用教程](./docs/docker.md)
### 方法一: 本地使用[教程](https://github.com/Sitoi/dailycheckin/blob/main/docs/local.md)
### 方法三: GitHub Action 使用
### 方法二: Docker 使用[教程](https://github.com/Sitoi/dailycheckin/blob/main/docs/docker.md)
参考教程: [GitHub Action 使用教程](./docs/github-actions.md)
### 方法四: 腾讯云函数使用
参考教程: [腾讯云函数使用教程](./docs/tencent-scf.md)
### 方法三: GitHub Action 使用[教程](https://github.com/Sitoi/dailycheckin/blob/main/docs/github-actions.md)
### 方法四: 腾讯云函数使用[教程](https://github.com/Sitoi/dailycheckin/blob/main/docs/tencent-scf.md)
## 新增签到脚本需求
如有签到脚本需求,请到 [ISSUE](https://github.com/Sitoi/DailyCheckIn/issues/new/choose) 中提交
如有签到脚本需求,请到 [ISSUE](https://github.com/Sitoi/dailycheckin/issues/new/choose) 中提交
## 特别鸣谢(排名不分先后)

View File

@ -1,6 +1,6 @@
## Docker 使用教程
# Docker 使用教程
### 一、新建目录结构
## 一、新建目录结构
```text
dailycheckin
@ -14,17 +14,17 @@ dailycheckin
- dailycheckin/config.json: 配置文件
- dailycheckin/docker-compose.yml: docker启动文件
### 二、修改配置文件等
## 二、修改配置文件等
#### dailycheckin/logs
### dailycheckin/logs
建一个空文件夹就行
#### dailycheckin/config.json
### dailycheckin/config.json
参考[配置说明文档](./settings.md) ,并修改 `config.json`
参考[配置说明文档](https://github.com/Sitoi/dailycheckin/blob/main/docs/settings.md) ,并修改 `config.json`
#### dailycheckin/docker-compose.yml
### dailycheckin/docker-compose.yml
```yaml
version: '3'
@ -39,11 +39,18 @@ services:
- ./logs:/dailycheckin/logs
```
### 三、启动 docker
## 三、启动 docker
目录文件配置好之后在 `dailycheckin` 目录执行。
- `docker-compose up -d` 启动(修改 docker-compose.yml 后需要使用此命令使更改生效)
```bash
docker-compose up -d
```
> 修改 `docker-compose.yml` 后需要使用上述命令使更改生效
## 附录
- `docker-compose logs` 打印日志
- `docker-compose pull` 更新镜像
- `docker-compose stop` 停止容器

View File

@ -1,8 +1,8 @@
## GitHub Actions 使用教程
# GitHub Actions 使用教程
### 一、fork 本项目
## 一、fork 本项目
### 二、配置项目 Secrets
## 二、配置项目 Secrets
> _**斜体加粗大写英文字母**_ 表示 GitHub Actions Secrets 环境变量名称,内容直接复制 _**斜体加粗大写英文字母 key**_ 对应的 value
@ -10,12 +10,12 @@
> _**斜体加粗大写英文字母**_ 表示 GitHub Actions Secrets 环境变量名称,内容直接复制 _**斜体加粗大写英文字母 key**_ 对应的 value
参考[配置说明文档](./settings.md) ,并修改 `config.json`
参考[配置说明文档](https://github.com/Sitoi/dailycheckin/blob/main/docs/settings.md) ,并修改 `config.json`
### 三、Star 一下,立即执行,观察运行情况
## 三、Star 一下,立即执行,观察运行情况
点一下自己 fork 项目的 star 立即执行
### 四、开启定时运行
## 四、开启定时运行
必须修改一次文件(比如自己库中的 `README.md` 文件)才能定时运行

View File

@ -1,24 +1,24 @@
## 本地使用教程
# 本地使用教程
### 下载Clone本项目到本地
## 一、下载Clone本项目到本地
> 下载的需要解析压缩包
下载地址: [https://github.com/Sitoi/DailyCheckIn/archive/main.zip](https://github.com/Sitoi/DailyCheckIn/archive/main.zip)
Clone 地址: [https://github.com/Sitoi/dailycheckin.git](https://github.com/Sitoi/dailycheckin.git)
> 下载的需要解析压缩包
## 二、拷贝 `config.template.json``config.json` 并修改
### 一、拷贝 `config.template.json``config.json` 并修改
参考[配置说明文档](https://github.com/Sitoi/dailycheckin/blob/main/docs/settings.md) ,并修改 `config.json`
参考[配置说明文档](./settings.md) ,并修改 `config.json`
### 二、安装 Pypi 依赖包
## 三、安装 Pypi 依赖包
```bash
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```
### 三、单次运行
##、单次运行
> 运行【日常签到类】(除喜马拉雅极速版&企鹅读书)

View File

@ -1,4 +1,4 @@
## 配置说明
# 配置说明
配置文件:`config.json`
@ -211,6 +211,10 @@
[百度搜索资源平台](https://ziyuan.baidu.com/site/index#/)
![获取百度云提交链接教程](https://cdn.jsdelivr.net/gh/Sitoi/dailycheckin/docs/img/submit_url.png)
- _**BAIDU_URL_SUBMIT_LIST**_.data_url: 提交网站的 URL
链接,参考链接:[https://cdn.jsdelivr.net/gh/Sitoi/Sitoi.github.io/baidu_urls.txt](https://cdn.jsdelivr.net/gh/Sitoi/Sitoi.github.io/baidu_urls.txt)
- _**BAIDU_URL_SUBMIT_LIST**_.submit_url: 提交百度网站的目标
@ -223,7 +227,7 @@
![获取 cookie 教程](https://cdn.jsdelivr.net/gh/Sitoi/dailycheckin/docs/img/iqiyi_cookie.png)
1. 进入[爱奇艺IQIYI官网](https://www.iqiyi.com/)
1. 进入[爱奇艺官网](https://www.iqiyi.com/)
2. 按 `F12` 打开开发者工具,刷新页面
3. 点击 `Network` 标签
4. 选择 `Doc` 标签

View File

@ -2,8 +2,20 @@
> (腾讯云函数相关教程请自行百度)
1. [点击下载代码](https://github.com/Sitoi/dailycheckin/archive/main.zip)
2. 解压代码压缩包
3. 根据各个使用文档获取对应的参数,并修改 `config.json`
4. 上传至【腾讯云函数】
5. 配置定时触发器
## 一、下载Clone本项目到本地
> 下载的需要解析压缩包
下载地址: [https://github.com/Sitoi/DailyCheckIn/archive/main.zip](https://github.com/Sitoi/DailyCheckIn/archive/main.zip)
Clone 地址: [https://github.com/Sitoi/dailycheckin.git](https://github.com/Sitoi/dailycheckin.git)
## 二、拷贝 `config.template.json``config.json` 并修改
参考[配置说明文档](https://github.com/Sitoi/dailycheckin/blob/main/docs/settings.md) ,并修改 `config.json`
## 三、上传至【腾讯云函数】
## 四、配置定时触发器
待完善