From 239f51748e992e19f4eee97fcdead900dca2837a Mon Sep 17 00:00:00 2001 From: Slávek Banko Date: Thu, 21 Oct 2021 21:44:17 +0200 Subject: Change README to markdown format. Add translation status overview. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Slávek Banko (cherry picked from commit e3388a61d265bc5908eb409ac8f8335bf6657264) --- README | 38 -------------------------------------- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 38 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 0ba9341..0000000 --- a/README +++ /dev/null @@ -1,38 +0,0 @@ - - - KchmViewer - a chm files viewer. - - - Kchmviewer is a chm files (MS HTML help file format) viewer. - The main advantage of KchmViewer is extended support for non-English - languages. KchmViewer in most cases correctly detects chm file encoding, - correctly shows tables of context of Russian, Korean, Chinese and - Japanese help files. It searches in non-English help files (albeit, the - search for MBCS languages - ja/ko/ch is still in progress.) - - - -FEATURES: -========= - - - Has support for TDEIO slave, TDEHTML and K*Widget. - - Safe and harmless, kchviewer does not support JavaScript, - optionally warns you before opening an external web page or switching - to another help file. - - Detects and shows encoding of any valid chm file. - - Shows non-English chm files, including cyrillic, chinese, japanese... - - Search in non-English chm files using chm built-in search index. - - Shows an appropriate image for every TOC entry. - - Has chm index support, including multiple index entries, cross-links - and parent/child entries in index. - - Persistent bookmarks support. Kchviewer stores the screen position - for every bookmark. - - For any opened chm files, stores the last opened window, search history, - bookmark history, font size, etc, so when you open this file again, - everything is on the last place. - - Has easy and powerful search-in-page support. - - Allows to increase or decrease the font size, so partially sighted - people can read texts easily. - - Has standard Back/Forward/Home navigation. - - Can print the opened pages on a standard printer (usually via CUPS). - - Has complex search query support. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a6864ba --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ + + KchmViewer - a chm files viewer. + + +Kchmviewer is a chm files (MS HTML help file format) viewer. +The main advantage of KchmViewer is extended support for non-English +languages. KchmViewer in most cases correctly detects chm file encoding, +correctly shows tables of context of Russian, Korean, Chinese and +Japanese help files. It searches in non-English help files (albeit, the +search for MBCS languages - ja/ko/ch is still in progress.) + + +Features: +--------- + +- Has support for TDEIO slave, TDEHTML and K*Widget. +- Safe and harmless, kchviewer does not support JavaScript, + optionally warns you before opening an external web page or switching + to another help file. +- Detects and shows encoding of any valid chm file. +- Shows non-English chm files, including cyrillic, chinese, japanese... +- Search in non-English chm files using chm built-in search index. +- Shows an appropriate image for every TOC entry. +- Has chm index support, including multiple index entries, cross-links + and parent/child entries in index. +- Persistent bookmarks support. Kchviewer stores the screen position + for every bookmark. +- For any opened chm files, stores the last opened window, search history, + bookmark history, font size, etc, so when you open this file again, + everything is on the last place. +- Has easy and powerful search-in-page support. +- Allows to increase or decrease the font size, so partially sighted + people can read texts easily. +- Has standard Back/Forward/Home navigation. +- Can print the opened pages on a standard printer (usually via CUPS). +- Has complex search query support. + +. + +Contributing +-------------- + +If you wish to contribute to kchmviewer, you might do so: + +- TDE Gitea Workspace (TGW) collaboration tool. + https://mirror.git.trinitydesktop.org/gitea + +- TDE Weblate Translation Workspace (TWTW) collaboration tool. + https://mirror.git.trinitydesktop.org/weblate + + +Translations status +--------------------- + +### messages +[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kchmviewer/multi-auto.svg +"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kchmviewer/) + +### desktop files +[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kchmviewer-desktop-files/multi-auto.svg +"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kchmviewer-desktop-files/) -- cgit v1.2.3