Skip to content

Commit d38ed42

Browse files
authored
Update README.md
1 parent 797ce90 commit d38ed42

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@ Next generation of fcitx
22
==========================
33
Fcitx 5 is a generic input method framework released under LGPL-2.1+.
44

5+
# Resources
6+
57
[![Jenkins Build Status](https://img.shields.io/jenkins/s/https/jenkins.fcitx-im.org/job/fcitx5.svg)](https://jenkins.fcitx-im.org/job/fcitx5/)
68
[![Coverity Scan Status](https://img.shields.io/coverity/scan/9063.svg)](https://scan.coverity.com/projects/fcitx-fcitx5)
79
[![Documentation](https://codedocs.xyz/fcitx/fcitx5.svg)](https://codedocs.xyz/fcitx/fcitx5/)
810

911
* Wiki: [https://fcitx-im.org/](https://fcitx-im.org/)
1012
- Registration require explicit approval due to the spam, please send an email to the mail list if you do not get approved.
1113
* Discussion:
12-
- Email: [fcitx [at] googlegroups.com](https://groups.google.com/g/fcitx)
14+
- Email: Send email to [fcitx@googlegroups.com](https://groups.google.com/g/fcitx)
1315
- Github Discussions: [https://github.com/fcitx/fcitx5/discussions](https://github.com/fcitx/fcitx5/discussions)
1416
* Chat Group:
1517
- Following methods are all bridged together, you can pick any that works.
@@ -21,5 +23,30 @@ Fcitx 5 is a generic input method framework released under LGPL-2.1+.
2123
* Translation: [https://explore.transifex.com/fcitx/](https://explore.transifex.com/fcitx/)
2224
- Do not send pull request for translation updates.
2325
- The translation will be automatically pushed to git repository nightly, but not vice versa.
26+
27+
# Supported platform on Linux and BSD
28+
X11/Wayland
29+
30+
For using input method under TTY, please check [fbterm](https://github.com/fcitx/fcitx5-fbterm/) or [tmux](https://github.com/wengxt/fcitx5-tmux), not all features are supported.
31+
32+
# Quick start for Linux
33+
[Install Fcitx 5](https://fcitx-im.org/wiki/Install_Fcitx_5)
34+
35+
Looking for Mac or Android?
36+
[Mac](https://github.com/fcitx-contrib/fcitx5-macos/)
37+
[Android](https://github.com/fcitx5-android/fcitx5-android)
38+
39+
The main package (this repository) only contains keyboard layout engine.
40+
41+
Coressponding input method engines need to be installed to support other languages (e.g. Chinese/Japanese/Korean).
42+
43+
You may find the list of input method engines at [here](https://fcitx-im.org/wiki/Input_method_engines).
44+
45+
# For developers
46+
[Compiling fcitx5](https://fcitx-im.org/wiki/Compiling_fcitx5)
47+
48+
To write a input method (or addon) from scratch, check [Develop a simple input method](https://fcitx-im.org/wiki/Develop_an_simple_input_method)
49+
50+
# Packaging status
2451

2552
[![Packaging status](https://repology.org/badge/vertical-allrepos/fcitx5.svg)](https://repology.org/project/fcitx5/versions)

0 commit comments

Comments
 (0)