Мелочи по сборке и README
This commit is contained in:
39
README.md
39
README.md
@@ -5,22 +5,21 @@
|
||||
Консольная программа для проверки IPTV-плейлистов в формате m3u или m3u8.
|
||||
|
||||
> **Веб-сайт:** [m3u.su](https://m3u.su)
|
||||
> Исходный код: [git.axenov.dev/IPTV/iptvc](https://git.axenov.dev/IPTV/iptvc)
|
||||
> **Документация:** [m3u.su/docs](https://m3u.su/docs)
|
||||
> Исходный код: [git.axenov.dev/IPTV](https://git.axenov.dev/IPTV)
|
||||
> Telegram-канал: [@iptv_aggregator](https://t.me/iptv_aggregator)
|
||||
> Обсуждение: [@iptv_aggregator_chat](https://t.me/iptv_aggregator_chat)
|
||||
> Дополнительные сведения:
|
||||
> * [./docs](./docs)
|
||||
> * [git.axenov.dev/IPTV/.profile](https://git.axenov.dev/IPTV/.profile)
|
||||
> Бот: [@iptv_aggregator_bot](https://t.me/iptv_aggregator_bot)
|
||||
|
||||
## Установка
|
||||
|
||||
Достаточно скачать и распаковать архив с подходящим исполняемым файлом [со страницы последнего релиза](https://git.axenov.dev/IPTV/iptvc/releases/latest):
|
||||
|
||||
| ОС | Архив | Платформа |
|
||||
|---------|----------------------|-----------|
|
||||
| Linux | `linux_amd64.zip` | x64 |
|
||||
| MacOS | `darwin_amd64.zip` | x64 |
|
||||
| Windows | `windows_amd64.zip` | x64 |
|
||||
| ОС | Скачать для `amd64` | Скачать для `arm64` |
|
||||
| ------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| Linux | [linux_amd64.zip](https://git.axenov.dev/IPTV/iptvc/releases/download/latest/linux_amd64.zip) | [linux_arm64.zip](https://git.axenov.dev/IPTV/iptvc/releases/download/latest/linux_arm64.zip) |
|
||||
| MacOS | [darwin_amd64.zip](https://git.axenov.dev/IPTV/iptvc/releases/download/latest/darwin_amd64.zip) | [darwin_arm64.zip](https://git.axenov.dev/IPTV/iptvc/releases/download/latest/darwin_arm64.zip) |
|
||||
| Windows | [windows_amd64.zip](https://git.axenov.dev/IPTV/iptvc/releases/download/latest/windows_amd64.zip) | [windows_arm64.zip](https://git.axenov.dev/IPTV/iptvc/releases/download/latest/windows_arm64.zip) |
|
||||
|
||||
## Компиляция
|
||||
|
||||
@@ -29,7 +28,7 @@
|
||||
|
||||
1. Склонировать репозиторий
|
||||
2. Находясь в корне репозитория, следует выполнить `make` или `make help` для получения справки.
|
||||
3. Другой способ -- выполнить `go run .` для быстрого запуска.
|
||||
3. Другой способ — выполнить `go run .` для быстрого запуска.
|
||||
|
||||
## Быстрый старт
|
||||
|
||||
@@ -69,11 +68,11 @@
|
||||
|
||||
### Другие возможности команды `check`
|
||||
|
||||
* `--random|-r X` -- проверить X случайных плейлистов из ini-файла
|
||||
* `--json|-j` -- вывести результаты проверки в формате JSON
|
||||
* `--quiet|-q` -- полностью подавить вывод лога (включая отладочную информацию)
|
||||
* `--verbose|-v` -- добавить в лог более подробную отладочную информацию (значительно увеличит количество строк!)
|
||||
* `--tags|-t` -- файл с перечислением тегов (подробности см. [здесь](https://git.axenov.dev/IPTV/playlists#файл-channelsjson))
|
||||
* `--random|-r X` — проверить X случайных плейлистов из ini-файла
|
||||
* `--json|-j` — вывести результаты проверки в формате JSON
|
||||
* `--quiet|-q` — полностью подавить вывод лога (включая отладочную информацию)
|
||||
* `--verbose|-v` — добавить в лог более подробную отладочную информацию (значительно увеличит количество строк!)
|
||||
* `--tags|-t` — файл с перечислением тегов (подробности см. [здесь](https://git.axenov.dev/IPTV/playlists#файл-channelsjson))
|
||||
|
||||
Например, можно получить только json с результатами, передать его в `jq` и, отфильтровав результат, вывести названия оффлайн каналов:
|
||||
|
||||
@@ -126,8 +125,8 @@ pls='https://example.com/list2.m3u'
|
||||
### Параметры проверки
|
||||
|
||||
Выше в п.7 видно некоторые служебные данные:
|
||||
* `timeout` -- таймаут каждого запроса в секундах (макс. время ожидания ответа канала);
|
||||
* `routines` -- количество одновременных проверок.
|
||||
* `timeout` — таймаут каждого запроса в секундах (макс. время ожидания ответа канала);
|
||||
* `routines` — количество одновременных проверок.
|
||||
|
||||
Эти параметры рассчитываются динамически для каждого плейлиста в отдельности, исходя из количества каналов в каждом (`count`).
|
||||
См. [app/checker/checker.go](app/checker/checker.go) для подробностей.
|
||||
@@ -151,9 +150,9 @@ pls='https://example.com/list2.m3u'
|
||||
|
||||
### Коды возврата
|
||||
|
||||
* 0 -- успех
|
||||
* 1 -- общая ошибка, см. вывод
|
||||
* 2 -- команде `check` не переданы параметры `--file`, `--url` и `--code`
|
||||
* 0 — успех
|
||||
* 1 — общая ошибка, см. вывод
|
||||
* 2 — команде `check` не переданы параметры `--file`, `--url` и `--code`
|
||||
|
||||
## Лицензия
|
||||
|
||||
|
||||
Reference in New Issue
Block a user