Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 3.08 KB

README.md

File metadata and controls

100 lines (69 loc) · 3.08 KB

Chewing Editor

GitHub Actions Status Coveralls Status

chewing-editor is a cross platform chewing user phrase editor. It provides a easy way to manage user phrase. With it, user can customize their user phrase to increase input performance.

Install

  • Arch Linux: install from AUR: Stable release, Development
  • Mageia: install via urpmi chewing-editor - available in cauldron, Mageia 6 and later.
  • Debian/Ubuntu Linux: install via apt-get install chewing-editor

Development

Tools Requirement

Build

chewing-editor can be built by the following commands:

cmake .
make

If cmake cannot find Qt5, check the environment variable CMAKE_PREFIX_PATH which shall point to Qt5 installation path. For example: C:\Qt\Qt5.1.1\5.1.1\msvc2012_64.

Test

A custom target make check is used to build and run unit test.

Coverage Report

chewing-editor integrates with gcov to provide code coverage report. The following commands will generate coverage report for unit test.

cmake . -DENABLE_GCOV=yes
make check
scripts/lcov.sh

The coverage report will be in coveragereport directory.

Translation

Update Translations

Please use the following steps to update translations:

  • cmake .
  • make lupdate
  • ts files will be updated by lupdate
  • Use linguist to edit ts files

Add A New Translation

Please use the following steps to add a new translation:

  • Add locale in CMakeFiles.txt
  • cmake .
  • make lupdate
  • ts files will be updated by lupdate
  • Use linguist to edit ts files

Known Issues

Bopomofo cannot Display Correctly

Qt5 before v5.3.0 has problem displaying bopomofo with HarfBuzz-NG. If you encounter this issue, please upgrade your Qt5 to v5.3.0, or run chewing-editor with QT_HARFBUZZ=old.

See also:

Bugs & Feature Request

Please report any bug & feature request to https://github.com/chewing/chewing-editor/issues

Author & Contributors

  • ChangZhuo Chen (陳昌倬)
  • 鄭鴻旗
  • Mike Tzou
  • Yao-Po Wang
  • Peter Dave Hello
  • David Kuo
  • Bruce Liu

Licenses