Skip to content

Commit ed578a0

Browse files
committed
docs: update README and INSTALL guide
1 parent a9ace92 commit ed578a0

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

INSTALL

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,31 @@
11
Installation Instructions
22
*************************
3+
34
0. Required:
4-
cmake >= 3.21.0
5-
ibus >= 1.3
6-
glib >= 2
7-
gob >= 2.0.16
8-
gtk >= 3
9-
libchewing >= 0.5.1
10-
11-
1. Remove the old build cache:
12-
13-
If you have previous ibus-chewing, or change between ibus 1.1 and ibus 1.2,
14-
You may need to remove CMakeCache.txt
155

16-
2. Extract source and enter the extracted directory, then:
6+
meson >= 0.57.0
7+
ibus-1.0 >= 1.3
8+
glib-2.0 >= 2
9+
gtk4 >= 4
10+
libadwaita-1
11+
libchewing >= 0.9.0
12+
13+
1. Extract source and enter the extracted directory, then:
1714

18-
cmake -B build . --install-prefix /usr
19-
cmake --build build
15+
meson setup build --buildtype release --prefix /usr
16+
meson compile -C build
2017

21-
3. Install and register schemas:
18+
2. Install and register schemas:
2219

23-
sudo cmake --build build -t install
20+
sudo meson install -C build
2421
sudo glib-compile-schemas /usr/share/glib-2.0/schemas/
2522

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

27-
4. Use iBus UI or run ibus-setup to add ibus-chewing.
28-
29-
5. Restart iBus and Enjoy!
25+
4. Restart iBus and Enjoy!
3026

3127
ibus restart
3228

33-
To see other available build targets, use
29+
To see other available build options, use
3430

35-
cmake --build build -t help
31+
meson configure build

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,24 @@ Bugs and enhancement can be filed to:
1414
* [GitHub](https://github.com/chewing/ibus-chewing/issues)
1515

1616

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

19-
RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s
19+
 [083B3CAB64267E5BAB7159673EF0C673DADCC30C][pgp_key] Libchewing Signing Key <release@chewing.im>
20+
21+
or the following [minisign][] public key
22+
23+
 RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s
2024

2125
For example, to verify the 2.0.0 release
2226

23-
minisign -Vm ibus-chewing-2.0.0-Source.tar.xz -P RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s
27+
gpgv ibus-chewing-2.1.7.tar.xz.asc ibus-chewing-2.1.7.tar.xz
28+
29+
or
2430

31+
minisign -Vm ibus-chewing-2.1.7.tar.xz \
32+
-P RWRzJFnXiLZleAyCIv1talBjyRewelcy9gzYQq9pd3SKSFBPoy57sf5s
33+
34+
[pgp_key]: https://chewing.im/.well-known/openpgpkey/hu/y84sdmnksfqswe7fxf5mzjg53tbdz8f5?l=release
2535
[minisign]: https://jedisct1.github.io/minisign/
2636

2737
# Development
@@ -33,20 +43,14 @@ contribute, please install clang-format and set the git pre-commit hook by:
3343
ln -s ../../pre-commit .git/hooks/pre-commit
3444
```
3545

36-
## For debugging ibus-chewing
46+
## Debug ibus-chewing
3747

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

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

45-
3. Run ibus-daemon in command line with following command:
46-
```
47-
export G_MESSAGES_DEBUG=all
48-
ibus-daemon -rvx
49-
```
52+
This will temporarily replace the current ibus-chewing engine with
53+
the one launched from the command line.
5054

5155
# Translation
5256

0 commit comments

Comments
 (0)