Change README to markdown format.

Add translation status overview.

Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
pull/3/head
Slávek Banko 3 years ago
parent 489b0ef1ae
commit e3388a61d2
No known key found for this signature in database
GPG Key ID: 608F5293A04BE668

@ -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.

@ -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/)
Loading…
Cancel
Save