documentation

addon/doc/en/readme.md

@@ -1,30 +1,38 @@
-# Дополнение Яндекс.Переводчик для NVDA
+# Yandex.Translate add-on for NVDA
 
-[Скачать версию 2020.12.18](https://github.com/alekssamos/YandexTranslate/releases/latest/download/YandexTranslate-2020.12.18.nvda-addon)
+[Home page](https://github.com/alekssamos/YandexTranslate/)
 
-После установки зайдите в **NVDA меню**, **Параметры**, **Жесты ввода**,
-назначте удобные вам сочетания клавиш для YandexTranslate. Или используйте уже предустановленные (ниже).
+After installation, go to the * * NVDA menu**, * * Tools**, **Input Gestures**,
+assign the keyboard shortcuts you need for YandexTranslate. Or use the already pre-installed ones (below).
 
-> Другие переводчики, такие, как "Translate", "InstantTranslate" и другие,
-> если есть, лучше отключить или удалить, во избежании конфликтов.
+> Other translators, such as "Translate", "InstantTranslate" and others,
+> if there is, it is better to disable or delete, in order to avoid conflicts.
 
-Переводит выделенный фрагмент текста  или содержимое из буфера обмена, есть автоматический (мгновенный) перевод речи NVDA.
+New: If it doesn't work, an error when creating a key or something like that,
+then open the NVDA Menu, Tools, Yandex Translate Settings
+and install the API on iOS.
+These keys are used 
+in the iPhone app and have not changed for more than 6 months,
+it should work better and more stable.
 
-Если  есть брайлевский дисплей, результат будет дублироваться и на него.
+The add-on translates the selected text fragment or content from the clipboard, there is an automatic (instant) translation of NVDA speech.
 
-> Не переводит? Настройте языковые пары.
-> Не помогло?
-> Поменяйте IP адрес / переподключитесь к интернету (выключить включить wifi роутер из разетки),
-> включить или выключить режим полёта и т.д.
+If there is a Braille display, the result will be duplicated on it as well.
 
-Дополнение можно настроить в NVDA меню, Сервис, Настройки Yandex Translate.
+> Doesn't translate? Set up language pairs.
+> Didn't help?
+> Change the IP address / reconnect to the Internet (turn off turn on the wifi router from the socket),
+> turn on or off airplane mode, etc.
 
-Поддерживается использование прокси сервера.
 
-Есть возможность работать с профилями конфигурации, например, для браузера Google Chrome одна языковая пара, для Unigram другая, а в программе Блокнот вы хотите включить звуковой сигнал во время перевода. **NVDA меню**, **Профили конфигурации...**, для каждого приложения создаёте, переключаетесь и настраиваете переводчик.
+The add-on can be configured in the NVDA menu, Tools, Yandex Translate Settings.
 
-### Горячие клавиши
-* nvda+Shift+T - Перевод выделенного текста.
-* nvda+Shift+Y - Перевод текста из буфера обмена.
-* nvda+Shift+U - Поменять языки местами.
-* nvda+Shift+I - Автоматический перевод.
+The use of a proxy server is supported.
+
+It is possible to work with configuration profiles, for example, for the Google Chrome browser one language pair, for Unigram another, and in the Notepad program you want to turn on the sound signal during translation. ** NVDA menu**, * * Configuration profiles...** , for each application, create, switch, and configure the translator.
+
+### Keyboard shortcuts
+* nvda+Shift+T-Translate the selected text.
+* nvda+Shift+Y-Translate text from the clipboard.
+* nvda+Shift+U-Swap languages.
+* nvda+Shift+I - Automatic translation.

addon/doc/ru/readme.md

@@ -0,0 +1,36 @@
+# Дополнение Яндекс.Переводчик для NVDA
+
+[Домашняя страница](https://github.com/alekssamos/YandexTranslate/)
+
+После установки зайдите в **NVDA меню**, **Параметры**, **Жесты ввода**,
+назначте удобные вам сочетания клавиш для YandexTranslate. Или используйте уже предустановленные (ниже).
+
+> Другие переводчики, такие, как "Translate", "InstantTranslate" и другие,
+> если есть, лучше отключить или удалить, во избежании конфликтов.
+
+Новое: Если не работает, ошибка при создании ключа или что-нибудь такое,
+то откройте NVDA Меню, Сервис, Настройки Yandex Translate
+и установите API на iOS.
+Эти ключи используются в приложении для iPhone и не меняются уже больше 6 месяцев,
+должно работать лучше и стабильней.
+
+Дополнение переводит выделенный фрагмент текста  или содержимое из буфера обмена, есть автоматический (мгновенный) перевод речи NVDA.
+
+Если  есть брайлевский дисплей, результат будет дублироваться и на него.
+
+> Не переводит? Настройте языковые пары.
+> Не помогло?
+> Поменяйте IP адрес / переподключитесь к интернету (выключить включить wifi роутер из разетки),
+> включить или выключить режим полёта и т.д.
+
+Дополнение можно настроить в NVDA меню, Сервис, Настройки Yandex Translate.
+
+Поддерживается использование прокси сервера.
+
+Есть возможность работать с профилями конфигурации, например, для браузера Google Chrome одна языковая пара, для Unigram другая, а в программе Блокнот вы хотите включить звуковой сигнал во время перевода. **NVDA меню**, **Профили конфигурации...**, для каждого приложения создаёте, переключаетесь и настраиваете переводчик.
+
+### Горячие клавиши
+* nvda+Shift+T - Перевод выделенного текста.
+* nvda+Shift+Y - Перевод текста из буфера обмена.
+* nvda+Shift+U - Поменять языки местами.
+* nvda+Shift+I - Автоматический перевод.

addon/manifest.ini

@@ -4,7 +4,7 @@ description = """Translates text using service Yandex Translate."""
 author = "alekssamos <[email protected]>"
 url = https://github.com/alekssamos/YandexTranslate/
 version = 2021.02.10
-docFileName = None
+docFileName = readme.html
 minimumNVDAVersion = 2019.3
 lastTestedNVDAVersion = 2020.2
 updateChannel = None

buildVars.py

@@ -25,7 +25,7 @@
 	# URL for the add-on documentation support
 	"addon_url": "https://github.com/alekssamos/YandexTranslate/",
 	# Documentation file name
-	"addon_docFileName": None,
+	"addon_docFileName": "readme.html",
 	# Minimum NVDA version supported (e.g. "2018.3.0", minor version is optional)
 	"addon_minimumNVDAVersion": 2019.3,
 	# Last NVDA version supported/tested (e.g. "2018.4.0", ideally more recent than minimum version)