doc(docs): basic ru doc

This commit is contained in:
Alexey Kasyanchuk 2018-03-01 23:35:32 +03:00
parent 9f9c75a439
commit 30e2c53c67
7 changed files with 54 additions and 0 deletions

54
docs/USAGE.RU.md Normal file
View File

@ -0,0 +1,54 @@
## Использование
После инсталяции программы и запуска вам должно быть доступно основное окно программы:
[![After start](img/main_no_torrents.png)](https://github.com/DEgITx/rats-search)
После старта, изначально у вас нету базу поиска. Можно использовать готовые базы поиска, предварительно скопировав их в папку с настройками.
Сбор новых торрентов из сети должен начаться автоматически,через минуту-две после запуска программы (в случае корректно открытых портов).
Это можно отслеживать в поле "you have information about X торрент", а так же в списке поступления торрентов под ним. Скорость сбора торрентов будет увеличиваться с течением времени.
[![First](img/first_torrent.png)](https://github.com/DEgITx/rats-search)
В случае если сбор торрентов не происходит, или идет очень очень медленно (по 1-2 торренту в несколько минут), еследует удостовериться что порты указанные в настройках открыты. Об этом в следующем пункте.
### Настройка портов
[![Settings](img/settings.png)](https://github.com/DEgITx/rats-search)
Для корректной работы, необходимо чтобы были открыты порты 4445 и 4446 (или другие указанные в настройках). Должны быть открыты оба типа порта (UDP и TCP). На роутере порты обязательно должны быть проброшены через NAT (если таковой включен).
### Использование поиска
С течением времени ваша база торрентов естественным путем будет расти, и вы можете искать интересующий вас торрент используя поиск выше
[![A lot of torrents](img/base_big.png)](https://github.com/DEgITx/rats-search)
### Распределенный поиск
В случае найденных других клиентов ROTB о чем сигнализирует индикатор в нижней части
[![A lot of torrents](img/peer.png)](https://github.com/DEgITx/rats-search)
Вам будет доступен расширенный поиск среди других клиентов ROTB, для этого вам нужно выполнить обычный поиск, однако будут отображены дополнительные результаты выдачи. В зависимости от количества пиров и именно тех кого нашло результат расширенной выдачи может изменяться.
### Настройка сканнера торрентов
[![Settings](img/settings.png)](https://github.com/DEgITx/rats-search)
В настройках есть 3 параметра отвечающих за настройку поиска торрентов в сети, каждый из них влияет на нагрузку приложения, скорость сбора торрентов, генерацию траффика а так же общую нагрузку на оборудывание промежуточных узлов сети (роутера и т.п.)
Рекомендованные значения:
* Максимально быстрый поиск / высокая нагрузка:
** Scanner walk speed: 5
** Nodes usage: 0 (отключен = максимальное использование)
** Reduce netowrk packages: 0 (отключено = неограниченно)
* Средняя скорость поиска / средняя нагрузка:
** Scanner walk speed: 15
** Nodes usage: 100
** Reduce netowrk packages: 600
* Низкая скорость поиска / средняя нагрузка:
** Scanner walk speed: 30
** Nodes usage: 10
** Reduce netowrk packages: 450

BIN
docs/img/base_big.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

BIN
docs/img/first_torrent.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

BIN
docs/img/peer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

BIN
docs/img/settings.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

BIN
docs/img/torrents_count.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB