Initial commit

src/iptvc/quickstart.md

@@ -0,0 +1,79 @@
+---
+icon: material/flag-checkered
+tags: ["iptvc"]
+---
+
+# :material-flag-checkered: Быстрый старт
+
+## Проверить плейлист по прямой ссылке
+
+```
+./iptvc check --url https://example.com/pls.m3u
+```
+
+## Проверить файл плейлист с диска
+
+```
+./iptvc check --file /home/user/pls.m3u
+```
+
+## Проверить плейлист по короткому коду из [`playlists.ini`](../formats/playlists.md)
+
+```
+./iptvc check --code X
+```
+
+Файл `playlists.ini` должен лежать рядом с `iptvc`.
+
+Если файл лежит в другой директории, то можно явно указать путь к нему:
+
+```
+./iptvc check --code X --ini /home/user/playlists.ini
+```
+
+Если ini-файл не будет найден, программа предупредит об этом.
+
+## Присвоить каналам тематические теги
+
+Чтобы это произошло, рядом с `iptvc` должен лежать файл [channels.json](../formats/channels.md).
+
+Если файл лежит в другой директории, то можно указать её явно:
+
+```
+./iptvc check --tags /home/user/channels.json <...другие аргументы...>
+```
+
+Если json-файл не будет найден, то программа предупредит о том, что теги не будут присвоены, и продолжит работу.
+
+## Проверить несколько плейлистов одновременно
+
+Для этого можно комбинировать все аргументы, пречисленные выше, с учётом особенностей их работы:
+
+```
+./iptvc check \
+    --ini /home/user/p.ini \
+    --tags /home/user/c.json \
+    --code Y \
+    --file /home/user/tv.m3u \
+    --url https://example.com/pls1.m3u \
+    --url https://example.com/pls2.m3u
+```
+
+В этом примере (построчно):
+
+* вызывать команду проверки;
+* взять список плейлистов из файла `/home/user/p.ini`;
+* применить правила присвоения тегов из файла `/home/user/c.json`;
+* проверить плейлист с кодом `Y` из ini-файла;
+* проверить плейлист из файла `/home/user/tv.m3u`;
+* проверить плейлист по ссылке `https://example.com/pls1.m3u`;
+* проверить плейлист по ссылке `https://example.com/pls2.m3u`.
+
+Символ `\` нужен только для наглядного разделения аргументов на несколько строк.
+
+Переданные плейлисты будут обработаны в следующем порядке:
+
+1. локальные файлы плейлистов;
+2. плейлисты по ссылкам;
+3. плейлисты по кодам из ini-файла.
+