Add usage documentation

.goreleaser.yml

@@ -36,6 +36,9 @@ archives:
       format: zip
     - goos: darwin
       format: zip
+  files:
+    - USAGE.md
+    - LICENSE
 checksum:
   name_template: 'checksums.txt'
 snapshot:

USAGE.md

@@ -0,0 +1,64 @@
+# NNM-Club Uploaders Tools
+
+Данная программа предназначена для загрузки торрент-файлов из разделов форума NNM-Club. Использование этой программы разрешено только действующим участникам релиз-группы Uploaders. Если вы не принадлежите к их числу, удалите программу немедленно!
+
+## Как использовать GUI-версию
+
+GUI для данной программы пока отсутствует, но планируется до конца года.
+
+## Как использовать консольную версию
+
+Для начала, распакуйте архив, соответствующий вашей операционной системе и архитектуре в папку, в которой вы планируете запускать программу, после чего откройте программу командной строки.
+
+* Для Windows это может быть cmd.exe, Windows PowerShell или Windows Terminal
+* Для Linux — терминал из поставки вашего DE, или же просто голая консоль
+* Для macOS — Terminal.app или iTerm2
+
+Перейдите в папку, в которой у вас появился файл `massdl` (или `massdl.exe` в случае Windows). Обычно для перехода в папку нужно выполнить команду `cd /путь/к/папке/` (или `cd буква_диска:\путь\к\папке` в случае Windows).
+
+Любые дальнейшие действия предполагают, что вы находитесь в терминале, в котором открыта папка с файлом `massdl`/`massdl.exe`.
+
+### Авторизация в NNM-Club
+
+Прежде всего, нам необходимо сконфигурировать программу. Для этого запустите `./massdl -auth`
+
+Приложение попросит вас последовательно ввести следующие данные:
+
+* Домен NNM-Club: текущий домен, на котором работает форум.
+* Имя пользователя: ваше имя пользователя.
+* Пароль: ваш пароль.
+
+После ввода всех данных приложение попробует авторизоваться на сайте, и сообщит, смогло ли оно это сделать. Если оно не смогло войти на сайт — повторите запуск `./massdl -auth`, убедившись, что вы вводите правильный пароль, а сервер форума доступен для связи (иногда для стабильного соединения нужен VPN).
+
+После успешного логина можно приступать к скачиванию торрент-файлов.
+
+### Скачивание торрентов
+
+Для скачивания торрентов запустите команду `./massdl -forum <номер_форума>`, в которой `<номер_форума>` — число без кавычек, которое видно в адресной строке, если открыть этот форум. К примеру, для форума "Native *Nix Games", чей адрес https://nnmclub.ro/forum/viewforum.php?f=1193, номер форума равен 1193.
+
+Расширенная опция `-outputDir` позволяет указать конкретную папку, в которой будет создана папка с торрент-файлами. По умолчанию папка с торрент-файлами создаётся рядом с файлом `massdl`/`massdl.exe`.
+
+Пример: чтобы скачать форум "Native *Nix Games", а торрент-файлы из него появились на рабочем столе в Windows, программу следует вызвать следующим образом:
+
+```sh
+./massdl -forum 1193 -outputDir C:\Users\MyUsername\Desktop
+```
+
+## Особенности работы программы
+
+Для любой версии этой программы верны следующие особенности:
+
+* Программа работает по методу best effort: к сожалению, так как в её основе парсинг HTML, нет 100% гарантии, что будут скачаны все торрент-файлы. Однако, даётся гарантия, что будут обнаружены все топики указанного форума, и в логах можно будет посмотреть, с какими из них возникли проблемы.
+* При сетевых ошибках программа пытается повторить запрос 5 раз, после чего прекращает попытки.
+* Вне зависимости от указанного пути сохранения торрентов будет создана поддиректория с названием, равным номеру форума, в которой будут лежать все торренты.
+* Торренты в директории сортируются по дате последнего обновления.
+* Топики, не проверенные модераторами, игнорируются.
+* Подфорумы игнорируются — для них следует запускать программу ещё раз с номером подфорума.
+* Скачивание нескольких форумов за раз пока не поддерживается.
+* К сожалению, пока что логи не сохраняются на диск.
+
+Указанные выше особенности могут быть исправлены/пересмотрены в будущем.
+
+## Багрепортинг и фичреквестинг
+
+Единственное место, где принимаются сообщения об ошибках в программе и пожелания по её улучшению — топик на форуме NNM-Club. Подобные запросы в личные сообщения форума будут игнорироваться, а за пределами форума — приводить к потере возможности коммуницировать с автором. Автор обязуется обрабатывать сообщения в теме форума хотя бы раз в неделю.