Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 17 additions & 21 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -1,35 +1,31 @@
Installation Instructions
*************************

0. Required:
cmake >= 3.21.0
ibus >= 1.3
glib >= 2
gob >= 2.0.16
gtk >= 3
libchewing >= 0.5.1

1. Remove the old build cache:

If you have previous ibus-chewing, or change between ibus 1.1 and ibus 1.2,
You may need to remove CMakeCache.txt

2. Extract source and enter the extracted directory, then:
meson >= 0.57.0
ibus-1.0 >= 1.3
glib-2.0 >= 2
gtk4 >= 4
libadwaita-1
libchewing >= 0.9.0

1. Extract source and enter the extracted directory, then:

cmake -B build . --install-prefix /usr
cmake --build build
meson setup build --buildtype release --prefix /usr
meson compile -C build

3. Install and register schemas:
2. Install and register schemas:

sudo cmake --build build -t install
sudo meson install -C build
sudo glib-compile-schemas /usr/share/glib-2.0/schemas/

3. Use iBus UI or run ibus-setup to add ibus-chewing.

4. Use iBus UI or run ibus-setup to add ibus-chewing.

5. Restart iBus and Enjoy!
4. Restart iBus and Enjoy!

ibus restart

To see other available build targets, use
To see other available build options, use

cmake --build build -t help
meson configure build
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# IBus-Chewing

[![CI](https://github.com/chewing/ibus-chewing/actions/workflows/ci.yml/badge.svg)](https://github.com/chewing/ibus-chewing/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/chewing/ibus-chewing/graph/badge.svg?token=r1piKsG5uF)](https://codecov.io/gh/chewing/ibus-chewing)

IBus-Chewing is an IBus front-end of Chewing, an intelligent Chinese input
method for Zhuyin (BoPoMoFo) users.

Expand All @@ -14,14 +17,24 @@ Bugs and enhancement can be filed to:
* [GitHub](https://github.com/chewing/ibus-chewing/issues)


ibus-chewing releases can be verified with the following [minisign][] public key
ibus-chewing releases can be verified with the following OpenPGP public key

 [083B3CAB64267E5BAB7159673EF0C673DADCC30C][pgp_key] Libchewing Signing Key <release@chewing.im>

RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s
or the following [minisign][] public key

 RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s

For example, to verify the 2.0.0 release

minisign -Vm ibus-chewing-2.0.0-Source.tar.xz -P RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s
gpgv ibus-chewing-2.1.7.tar.xz.asc ibus-chewing-2.1.7.tar.xz

or

minisign -Vm ibus-chewing-2.1.7.tar.xz \
-P RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s

[pgp_key]: https://chewing.im/.well-known/openpgpkey/hu/y84sdmnksfqswe7fxf5mzjg53tbdz8f5?l=release
[minisign]: https://jedisct1.github.io/minisign/

# Development
Expand All @@ -33,20 +46,14 @@ contribute, please install clang-format and set the git pre-commit hook by:
ln -s ../../pre-commit .git/hooks/pre-commit
```

## For debugging ibus-chewing
## Debug ibus-chewing

1. Quit existing ibus-daemon
* By right click on IBus systray icon, then quit, or
* kill the process, or
* with command: `ibus exit`
Run ibus-chewing in command line with verbose debug logging:

2. Edit `/usr/share/ibus/component/chewing.xml`, add `-v 7` to turn verbose level 7
G_MESSAGES_DEBUG=ibus-chewing /usr/libexec/ibus-engine-chewing -v 4

3. Run ibus-daemon in command line with following command:
```
export G_MESSAGES_DEBUG=all
ibus-daemon -rvx
```
This will temporarily replace the current ibus-chewing engine with
the one launched from the command line.

# Translation

Expand Down