aji/ScreenTranslator
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some info to readme.

Browse Source 
Add link to readme to the app.
This commit is contained in:
Gres 2022-01-30 14:15:57 +03:00
parent 7a8e8e510c
commit d5eb9f1855
2 changed files with 32 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -4,13 +4,13 @@
This software allows you to translate any text on screen.
Basically it is a combination of screen capture, OCR and translation tools.
Translation is currently done via online services.
## Installation
**Windows**: download archive from [github releases](https://github.com/OneMoreGres/ScreenTranslator/releases) page, extract it and run `.exe` file.
If the app fails to start with missing dll's error then install `vs_redist*.exe` from the release archive.
If you have any update errors related to SSL/TLS you should also install or repair `vcredist 2010` (from the Microsoft website).
If the app fails to start complaining about missing dlls or there are any update errors related to SSL/TLS then install or repair `vs_redist*.exe` from the release archive.
**Linux**: download `.AppImage` file from [github releases](https://github.com/OneMoreGres/ScreenTranslator/releases), make executable (`chmod +x <file>`) and run it.
@ -18,13 +18,27 @@ If you have any update errors related to SSL/TLS you should also install or repa
## Setup
Start the app, open the updates page of the settings window
and install required recognition languages, translators and, optionally,
hunspell dictionaries.
The app doesn't have a main window.
After start it shows only the tray icon.
After languages/translators installation set default recognition and
translation languages, enable some (or all) translators
and the `translate text` setting if needed.
If the app detects invalid settings, it will show the error message via system tray.
It will also highlight the section name in red on the left panel of the settings window.
Clicking on that section name will show a more detailed error message in the right panel (also in red).
The packages downloaded from this site do not include resources, such as recognition language packs or scripts to interact with online translation services.
To download them, open the settings window and go to the `Update` section.
In the right panel, expand the `recognizers` and `translators` sections.
Select preferred items, then right click and choose `Install/Update`.
After the progress bar reaches `100%`, the resource's state will change to `Up to Date`.
You must download at least one `recognizers` resource and one `translators` resource.
After finishing downloads, go to the `Recognition` section and update the default recognition language setting (the source to be translated).
Then go to the `Translation` section, update the default translation language setting (the language to be translated into) and enable some or all translation sevices (you may also change their order by dragging).
After that all sections in the left panel should be black.
Then click `Ok` to close settings.
## Usage
@ -36,6 +50,12 @@ and the `translate text` setting if needed.
## FAQ
By default resources are downloaded to the one of the user's folders.
If `Portable` setting in `General` section is checked, then resources will be downloaded to the app's folder.
If you are experiencing crashes during the app usage, then try changing `tesseract library version` from `Optimized` to `Compatible`.
It provides the same functionality, but should work on the bigger variety of hardware.
Answers to some frequently asked questions can be found in issues or
[wiki](https://github.com/OneMoreGres/ScreenTranslator/wiki/FAQ)

4
src/settingseditor.cpp
View File

@ -190,11 +190,15 @@ SettingsEditor::SettingsEditor(Manager &manager, update::Updater &updater)
baseUrl + "/blob/master/share/Changelog_" +
(locale.language() == QLocale::Russian ? "ru" : "en") + ".md";
const auto license = baseUrl + "/blob/master/LICENSE.md";
const auto help = locale.language() == QLocale::Russian
? "https://translator.gres.biz/page/download/"
: baseUrl + "/blob/master/README.md";
const auto aboutLines = QStringList{
QObject::tr(
R"(<p>Optical character recognition (OCR) and translation tool</p>)"),
QObject::tr(R"(<p>Version: %1</p>)")
.arg(QApplication::applicationVersion()),
QObject::tr(R"(<p>Setup instructions: <a href="%1">%1</a></p>)").arg(help),
QObject::tr(R"(<p>Changelog: <a href="%1">%2</a></p>)")
.arg(changelog, QUrl(changelog).fileName()),
QObject::tr(R"(<p>License: <a href="%3">MIT</a></p>)").arg(license),