docs(manual): updated usage guide

This commit is contained in:
Alexey Kasyanchuk 2018-07-30 21:24:46 +03:00
parent 1cec380202
commit 67badfbe75
11 changed files with 34 additions and 6 deletions

View File

@ -4,10 +4,16 @@
[![After start](img/main_no_torrents.png)](https://github.com/DEgITx/rats-search)
После старта, изначально у вас нету базы поиска. Можно использовать готовые базы поиска, предварительно скопировав их в папку с настройками.
Программа открывается на вкладке feed (лента). Здесь собраны наиболее актуальные торренты, с которыми были произведены какие-либо действия за последнее время (лайки, комментарии и т.п.). Если лента пуста, нужно просто дождаться синхронизации ее с любого из доступных пиров (о них ниже).
Изначально у вас нету базы поиска. Можно использовать готовые базы поиска, предварительно скопировав их в папку с настройками, либо дождаться накопления своей базы до достаточного размера, что будет проиходить автоматически при корректных настройках. Либо попросту использовать [распределенный поиск](#Распределенный-поиск).
Сбор новых торрентов из сети должен начаться автоматически через минуту-две после запуска программы (в случае корректно открытых портов).
Это можно отслеживать в поле "you have information about X торрент", а так же в списке поступления торрентов под ним. Скорость сбора торрентов будет увеличиваться с течением времени.
Это можно отслеживать в поле с торрентами под поиском, а так же в списке поступления торрентов во вкладке activity (активность).
[![A lot of torrents](img/peer.png)](https://github.com/DEgITx/rats-search)
Скорость сбора торрентов будет увеличиваться с течением времени работы программы. Подробнее о настройке сканера описано в пункте с [настройкой сканера торрентов](#Настройка-сканнера-торрентов).
[![First](img/first_torrent.png)](https://github.com/DEgITx/rats-search)
@ -21,7 +27,7 @@
### Использование поиска
С течением времени ваша база торрентов естественным путем будет расти, и вы можете искать интересующий вас торрент, используя поиск выше.
С течением времени ваша база торрентов естественным путем будет расти, и вы можете искать интересующий вас торрент, используя поиск в шапке.
[![A lot of torrents](img/base_big.png)](https://github.com/DEgITx/rats-search)
@ -56,3 +62,11 @@
* Скорость прохода: 30
* Использование узлов: 10
* Сократить количество сетевых пакетов: 450
### Настройка фильтров торрентов
В некоторых случаях вас могут не интересовать торренты определенного типа, размера или языка, и вы хотите чтобы сканер их игнорировал, а ваша база их не сохраняла. Для этого используется отдельное окно настроек фильтров торрентов.
[![Filters](img/filters.png)](https://github.com/DEgITx/rats-search)
Для этого нужно выбрать соотвествующие настройки и сохранить их. После этого в зависимости от надобности можно проверить и очистить базу в соостветствии с новыми настройками.

View File

@ -4,10 +4,16 @@ After installing the program and running, you should have access to the main pro
[![After start](img/main_no_torrents.png)](https://github.com/DEgITx/rats-search)
After the start, initially you do not have a search database. You can use ready-made search when copy datatabase into the settings folder.
The program opens on the feed tab by default. In the tab there are most relevant torrents that are collected, with which some actions have been performed recently (recent likes, comments, etc.). If the tab is empty, you just need to wait for it to sync with any of the available peers (see below).
After the start, initially you do not have a search database. You can use ready-made search when copy datatabase into the settings folder, or wait until you have accumulated your database to a sufficient size, which will automatically happen if the settings are correct. Or simply use [distributed search](#distributed-search).
Collection of new torrents from the network should start automatically, in a minute or two after the program is launched (in case of correctly opened ports).
This can be tracked in the "you have information about X torrent" field, as well as in the list of torrent feeds under it. The speed of the collection of torrents will increase with time.
This can be monitored in the field with torrents under the search, as well as in the list of torrents in the activity tab.
[![A lot of torrents](img/peer.png)](https://github.com/DEgITx/rats-search)
The speed of the collection of torrents will increase with time. For details on configuring the scanner, refer to the [torrent scanner configuration](#torrent-scanner-settings).
[![First](img/first_torrent.png)](https://github.com/DEgITx/rats-search)
@ -21,7 +27,7 @@ For correct operation, it is necessary that ports 4445 and 4446 (or others speci
### Using search
Over time, your database of torrents will naturally grow up, and you can search for the torrent you are interested in using the search above.
Over time, your database of torrents will naturally grow up, and you can search for the torrent you are interested in using the search.
[![A lot of torrents](img/base_big.png)](https://github.com/DEgITx/rats-search)
@ -56,3 +62,11 @@ Recommended values:
* Scanner walk speed: 30
* Nodes usage: 10
* Reduce netowork packages: 450
### Configuring global torrent filters
In some cases, you may not be interested in torrents of a certain type, size or language, and you want the scanner to ignore them, and your database does not save them. To do this, use settings area for the settings of torrent filter
[![Filters](img/filters.png)](https://github.com/DEgITx/rats-search)
To do this, select the appropriate settings and save them. After that, depending on the need, you can check and clean the database in accordance with the new settings.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 689 KiB

After

Width:  |  Height:  |  Size: 169 KiB

BIN
docs/img/filters.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 544 KiB

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 542 KiB

After

Width:  |  Height:  |  Size: 165 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 220 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 304 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 250 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 551 KiB

After

Width:  |  Height:  |  Size: 169 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB