README.rst
1==========
2Fcitx-m17n
3==========
4
5This is the source tree of fcitx-m17n, some trivial little codes the wrap the
6m17n input method engine into a fcitx input method.
7
8Source Tree
9===========
10
11* im:
12 Most codes.
13* po:
14 Translation files suitable for GNU gettext.
15* testmim:
16 A trivial standalone frontend to the m17n input methods engine.
17
18Dependency, Building and Installation
19=====================================
20
21Fcitx-m17n is maintained using CMake. To install, run::
22
23 mkdir build; cd build
24 cmake .. [ FLAGS ]
25 make && make install
26
27To install to /usr, include ``-DCMAKE_INSTALL_PREFIX=/usr`` in ``FLAGS``. To
28build with debug symbols, include ``-DCMAKE_BUILD_TYPE``. You may as well
29replace ``cmake`` with ``ccmake``, which gives you a nice curses UI to adjust
30CMake flags.
31
32Dependencies is handled by CMake and therefore not listed here. But note that
33testmim uses some C++11 features and requires a recent C++ compiler. Latest
34clang will suffice.
35
36You may want to read ``CMakeLists.txt`` in the subdirectories.
37
38License
39=======
40
41All codes are currently licensed in LGPL 2.1+.
42
43See ``COPYING`` for a copy of the license. A list of of fcitx-m17n authors and
44contributors is included herein:
45
46* Cheer Xiao
47* CSSlayer
48
49