Skip to content

Commit

Permalink
update:md
Browse files Browse the repository at this point in the history
  • Loading branch information
Guovin committed Dec 12, 2024
1 parent 53decd7 commit 1ab7ca7
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 97 deletions.
37 changes: 11 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,7 @@
<img src="https://img.shields.io/github/downloads/guovin/iptv-api/total" />
</a>
<a href="https://hub.docker.com/repository/docker/guovern/iptv-api">
<img src="https://img.shields.io/docker/pulls/guovern/iptv-api?label=docker:iptv-api" />
</a>
<a href="https://hub.docker.com/repository/docker/guovern/tv-requests">
<img src="https://img.shields.io/docker/pulls/guovern/tv-requests?label=docker:requests" />
</a>
<a href="https://hub.docker.com/repository/docker/guovern/tv-driver">
<img src="https://img.shields.io/docker/pulls/guovern/tv-driver?label=docker:driver" />
<img src="https://img.shields.io/docker/pulls/guovern/iptv-api" />
</a>
<a href="https://github.com/Guovin/iptv-api/fork">
<img src="https://img.shields.io/github/forks/guovin/iptv-api" />
Expand Down Expand Up @@ -138,31 +132,24 @@ Fork 本项目并开启工作流更新,具体步骤请见[详细教程](./docs

### 方式二:命令行

```python
pip
install
pipenv
```shell
pip install pipenv
```

```python
pipenv
install - -dev
```shell
pipenv install --dev
```

启动更新:

```python
pipenv
run
dev
```shell
pipenv run dev
```

启动服务:

```python
pipenv
run
service
```shell
pipenv run service
```

### 方式三:GUI 软件
Expand All @@ -171,10 +158,8 @@ service

2. 或者在项目目录下运行以下命令,即可打开 GUI 软件:

```python
pipenv
run
ui
```shell
pipenv run ui
```

<img src="./docs/images/ui.png" alt="IPTV-API更新软件" title="IPTV-API更新软件" style="height:600px" />
Expand Down
37 changes: 11 additions & 26 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,7 @@
<img src="https://img.shields.io/github/downloads/guovin/iptv-api/total" />
</a>
<a href="https://hub.docker.com/repository/docker/guovern/iptv-api">
<img src="https://img.shields.io/docker/pulls/guovern/iptv-api?label=docker:iptv-api" />
</a>
<a href="https://hub.docker.com/repository/docker/guovern/tv-requests">
<img src="https://img.shields.io/docker/pulls/guovern/tv-requests?label=docker:requests" />
</a>
<a href="https://hub.docker.com/repository/docker/guovern/tv-driver">
<img src="https://img.shields.io/docker/pulls/guovern/tv-driver?label=docker:driver" />
<img src="https://img.shields.io/docker/pulls/guovern/iptv-api" />
</a>
<a href="https://github.com/Guovin/iptv-api/fork">
<img src="https://img.shields.io/github/forks/guovin/iptv-api" />
Expand Down Expand Up @@ -139,31 +133,24 @@ at [Detailed Tutorial](./docs/tutorial_en.md)

### Method 2: Command Line

```python
pip
install
pipenv
```shell
pip install pipenv
```

```python
pipenv
install - -dev
```shell
pipenv install --dev
```

Start update:

```python
pipenv
run
dev
```shell
pipenv run dev
```

Start service:

```python
pipenv
run
service
```shell
pipenv run service
```

### Method 3: GUI Software
Expand All @@ -173,10 +160,8 @@ service

2. Or run the following command in the project directory to open the GUI software:

```python
pipenv
run
ui
```shell
pipenv run ui
```

<img src="./docs/images/ui.png" alt="IPTV-API update software" title="IPTV-API update software" style="height:600px" />
Expand Down
33 changes: 20 additions & 13 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@

1. 创建文件
2. 模板文件命名为 user_demo.txt
3. 模板文件需要按照(频道分类,#genre#),(频道名称,频道接口)进行编写,注意是英文逗号。如果需要将该接口设为白名单(不测速、保留在结果最前),可在地址后添加$!即可,例如http://xxx$!。后面也可以添加额外说明信息,如:http://xxx$!白名单接口
3.
模板文件需要按照(频道分类,#genre#),(频道名称,频道接口)进行编写,注意是英文逗号。如果需要将该接口设为白名单(不测速、保留在结果最前),可在地址后添加$!即可,例如http://xxx$!
。后面也可以添加额外说明信息,如:http://xxx$!白名单接口
4. 点击 Commit changes...进行保存

![创建user_demo.txt](./images/edit-user-demo.png '创建user_demo.txt')
Expand All @@ -81,8 +83,8 @@
2. 配置文件命名为 user_config.ini
3. 粘贴默认配置
4. 修改模板和结果文件配置:
- source_file = config/user_demo.txt
- final_file = output/user_result.txt
- source_file = config/user_demo.txt
- final_file = output/user_result.txt
5. 点击 Commit changes...进行保存

![创建user_config.ini](./images/edit-user-config.png '创建user_config.ini')
Expand Down Expand Up @@ -124,15 +126,17 @@
这个时候就可以运行更新工作流了

1. 点击 Run workflow
2. 这里可以切换您要运行的仓库分支,由于 Fork 默认拉取的是 master 分支,如果您修改的模板和配置也在 master 分支,这里选择 master 就好了,点击 Run workflow 确认运行
2. 这里可以切换您要运行的仓库分支,由于 Fork 默认拉取的是 master 分支,如果您修改的模板和配置也在 master 分支,这里选择
master 就好了,点击 Run workflow 确认运行

![运行Workflow](./images/workflows-run.png '运行Workflow')

#### (3)Workflow 运行中:

稍等片刻,就可以看到您的第一条更新工作流已经在运行了!
![Workflow运行中](./images/workflow-running.png 'Workflow运行中')
(注意:由于运行时间取决于您的模板频道数量以及页数等配置,也很大程度取决于当前网络状况,请耐心等待,默认模板与配置一般需要 25 分钟左右。)
(注意:由于运行时间取决于您的模板频道数量以及页数等配置,也很大程度取决于当前网络状况,请耐心等待,默认模板与配置一般需要 25
分钟左右。)

#### (4)Workflow 取消运行:

Expand All @@ -147,9 +151,11 @@
https://ghp.ci/raw.githubusercontent.com/您的github用户名/仓库名称(对应上述Fork创建时的TV)/master/output/user_result.txt
![用户名与仓库名称](./images/rep-info.png '用户名与仓库名称')

如果访问该链接能正常返回更新后的接口内容,说明您的直播源接口链接已经大功告成了!将该链接复制粘贴到 TVBox 等软件配置栏中即可使用~
如果访问该链接能正常返回更新后的接口内容,说明您的直播源接口链接已经大功告成了!将该链接复制粘贴到 TVBox
等软件配置栏中即可使用~

- 注意:除了首次执行工作流需要您手动触发,后续执行(默认北京时间每日 6:00 与 18:00)将自动触发。如果您修改了模板或配置文件想立刻执行更新,可手动触发(2)中的 Run workflow 即可。
- 注意:除了首次执行工作流需要您手动触发,后续执行(默认北京时间每日 6:00 与 18:00)将自动触发。如果您修改了模板或配置文件想立刻执行更新,可手动触发(2)中的
Run workflow 即可。

### 4.修改工作流更新频率(可选)

Expand All @@ -174,23 +180,23 @@ https://ghp.ci/raw.githubusercontent.com/您的github用户名/仓库名称(
2. 运行更新
项目目录下打开终端 CMD 依次运行以下命令:

```python
```shell
pip install pipenv
```

```python
```shell
pipenv install --dev
```

启动更新:

```python
```shell
pipenv run dev
```

启动服务:

```python
```shell
pipenv run service
```

Expand All @@ -200,15 +206,16 @@ pipenv run service

2. 或者在项目目录下运行以下命令,即可打开 GUI 软件:

```python
```shell
pipenv run ui
```

![IPTV-API 更新软件](./images/ui.png 'IPTV-API 更新软件')

### 方式四:Docker

- iptv-api(完整版本):性能要求较高,更新速度较慢,稳定性、成功率高;修改配置 open_driver = False 可切换到 Lite 版本运行模式(推荐酒店源、组播源、关键字搜索使用此版本)
- iptv-api(完整版本):性能要求较高,更新速度较慢,稳定性、成功率高;修改配置 open_driver = False 可切换到 Lite
版本运行模式(推荐酒店源、组播源、关键字搜索使用此版本)
- iptv-api:lite(精简版本):轻量级,性能要求低,更新速度快,稳定性不确定(推荐订阅源使用此版本)

1. 拉取镜像:
Expand Down
Loading

0 comments on commit 1ab7ca7

Please sign in to comment.