|
11 | 11 | ### Использованные ресурсы
|
12 | 12 |
|
13 | 13 | * [Tinkoff investment Java SDK](https://github.com/TinkoffCreditSystems/invest-openapi-java-sdk) - получение списка доступных облигаций в Тинькофф инвестициях.
|
14 |
| -* [MOEX](https://iss.moex.com/) - получение детальной информации об облигации (названия, даты, купоны, последняя цена, ...). |
| 14 | +* [ISS MOEX](https://iss.moex.com/) - получение детальной информации об облигации (названия, даты, купоны, последняя цена, ...). |
15 | 15 |
|
16 | 16 | ### Требования перед запуском приложения
|
17 | 17 |
|
|
20 | 20 | * Аккаунт в Тинькофф инвестициях и ключ для API запросов. [Инструкция](https://tinkoffcreditsystems.github.io/invest-openapi/auth/) как его получить.
|
21 | 21 | * Стабильное Интернет-соединение.
|
22 | 22 |
|
23 |
| -### Первый запуск |
| 23 | +### Запуск приложения |
24 | 24 |
|
25 |
| -1. Скачайте последнюю версию приложения в отдельную директорию. Быстрое скачивание Windows: [EXE](https://github.com/Shemplo/TBS/releases/latest/download/TBS.exe). |
26 |
| -2. Полученный API токен поместите в файл `token.txt` в той же директории. |
27 |
| -3. Запустите приложение (EXE файл) двойным кликом по нему. |
28 |
| - |
29 |
| - Сначала откроется окно командной строки, затем пользовательский интерфейс (если не произойдёт фатальных ошибок). |
30 |
| - При запуске в режиме сканирования облигаций (в том числе при первом запуске) процесс может занять некоторое время (до 2-3х минут). |
| 25 | +1. Скачайте последнюю версию приложения в отдельную директорию. Быстрое скачивание **Windows**: [EXE](https://github.com/Shemplo/TBS/releases/latest/download/TBS.exe). |
| 26 | +2. Запустите приложение (EXE файл) двойным кликом по нему. Откроект окно launcher'а, которое позволит выбрать, что вы хотете сделать - |
| 27 | +открыть существующий набор облигаций или просканировать заново (перед этим выбрав профиль из списка). |
31 | 28 |
|
32 |
| -4. Если вы всё сделали правильно, то в появившемся окне приложения должна быть не пустая таблица с найденными облигациями. |
33 | 29 | * Для пользователей **не Windows** перед первым шагом придётся выполнить самостоятельную сборку приложения,
|
34 | 30 | потому что в приложении есть платформа-зависимые компоненты:
|
35 | 31 | 1. Склонируйте этот репозиторий к себе на компьютер.
|
|
38 | 34 | 4. Собранное приложение будет находится в директории `target`, файл `TBS.jar`. Для того, чтобы увидеть сообщения в консоли рекомендуется запускать этот файл
|
39 | 35 | через командную строку `java -jar TBS.jar`
|
40 | 36 |
|
41 |
| -### Продвинутый запуск и конфигурация |
42 |
| - |
43 |
| -По умолчанию приложение запустится с параметрами `DEFAULT_RUB`, заданные в файле [ProfilePreset.java](https://github.com/Shemplo/TBS/blob/master/src/main/java/ru/shemplo/tbs/entity/ProfilePreset.java). |
44 |
| -Если Вас это не устраивает, то приложение поддерживает гибкую кастомизацию параметров. |
45 |
| - |
46 |
| -* Если вы хотите использовать готовый пресет из того же файла, в консольной строке запустите приложение с именем пресета |
47 |
| - `TBS.exe RISCKY_RUB` или `java -jar TBS.jar RISCKY_RUB`. |
48 |
| -* Если вы хотите использовать полностью свой пресет: |
49 |
| - 1. Создайте `.xml` файл с любым именем `{{NAME}}` в той же директории, где находится приложение. |
50 |
| - 2. Скопируйте шаблон содержимого в созданный файл |
51 |
| - ```xml |
52 |
| - <?xml version="1.0" encoding="UTF-8"?> |
53 |
| - <profile> |
54 |
| - <name>Custom profile name</name> |
55 |
| - <token filename="{{TOKEN}}" responsible="1" /> |
56 |
| - <general mr="30" inflation="0.065" /> |
57 |
| - <params mte="24" cpy="4" mdtc="30" nv="1000.0" minp="6.0" maxpr="1000" /> |
58 |
| - <currencies>RUB</currencies> |
59 |
| - <cmodes>FIXED, NOT_FIXED</cmodes> |
60 |
| - <bannede>-1L</bannede> |
61 |
| - </profile> |
62 |
| - ``` |
63 |
| - 3. Измените необходимые параметры на Ваши значения. |
64 |
| - |
65 |
| - В теге `token` замените `{{TOKEN}}` на абсолютный или относительный путь до файла с вашим API токеном. |
66 |
| - Если какой-то атрибут тега `params` не указан (все они необязательные), то соответствующий параметр не будет использоваться для фильтрации. |
67 |
| - Имена атрибутов получены из первых букв слов в названии соответствующего параметра, которые можно увидеть в файле [ProfilePreset.java](https://github.com/Shemplo/TBS/blob/master/src/main/java/ru/shemplo/tbs/entity/ProfilePreset.java). |
68 |
| - В теге `bannede` можно перечислить через запятую идентификаторы эмитентов, облигации которых точно не должны попасть в таблицу с результатами сканирования. |
69 |
| - |
70 |
| - 4. Запустите приложение с Вашими параметрами `TBS.exe {{NAME}}.xml` или `java -jar TBS.jar {{NAME}}.xml`. |
71 |
| - |
72 | 37 | ### Куда смотреть, что нажимать?
|
73 | 38 |
|
74 | 39 | Приложение имеет довольно простой пользовательский интерфейс, и удобство использования должно прийти с опытом, но про некоторые моменты всё-таки стоит рассказать:
|
|
0 commit comments