Developer Documentation 👩‍🔧

Ibus-typing-booser is open source and licensed under the GPL version 3.

Reporting bugs 🐞

You can report bugs and suggest improvements in the github issue tracker: https://github.com/mike-fabian/ibus-typing-booster/issues

Translation 🇺🇳

You can contribute translations for ibus-typing-booster using the online translation platform weblate: https://translate.fedoraproject.org/projects/ibus-typing-booster/.

If you cannot use weblate, you can also create a pull request for new or updated translations.

Mailing list 📬

https://lists.fedorahosted.org/admin/lists/ibus-typing-booster.lists.fedorahosted.org/

Browse git repository 🐱

You can browse the source code at https://github.com/mike-fabian/ibus-typing-booster.

Anonymous git clone

$ git clone git://github.com/mike-fabian/ibus-typing-booster.git

Authorized git clone

$ git clone git@github.com:mike-fabian/ibus-typing-booster.git

Release tarballs

Release tarballs are available at https://github.com/mike-fabian/ibus-typing-booster/releases.

Building and installing from source 🛠️

Required packages for building

To build ibus-typing-booster, you will need at least:

If you build from a git checkout and not from a release tarball, you also need:

If you also want to run the test-suite with “make check”, you also need the following packages:

Building and installing using the source 🛠️

When using a git checkout, go to the directory of the checkout and use autogen.sh:

$ cd ibus-typing-booster
$ ./autogen.sh

autogen.sh automatically runs configure and you can give the same arguments to autogen.sh you can give to configure. See below for the right arguments for your distribution.

When using the source from a release tarball, unpack the tarball and go into the source directory:

$ tar xvf ibus-typing-booster-2.7.0.tar.gz
$ cd ibus-typing-booster-2.7.0

Now continue like this:

Fedora:

$ ./configure --prefix=/usr --libexecdir=/usr/libexec/
$ make
$ make check # optional
$ make install

openSUSE Leap 42.1 and newer:

$ ./configure --prefix=/usr --libexecdir=/usr/lib/ibus
$ make
$ make check # optional
$ make install

Ubuntu 20.04:

$ ./configure --prefix=/usr --libexecdir=/usr/lib/ibus
$ make
$ make check # optional
$ make install

For all distributions: please use --prefix=/usr and not the default /usr/local, installing into /usr/local will usually not work! And use the correct --libexecdir option for your distribution, the default is --libexecdir=/usr/libexec which is correct for Fedora, but on openSUSE and Debian based distributions it is --libexecdir=/usr/lib/ibus!

Required and optional packages for running

Note about m17n-lib: m17n-lib is required to use ibus-typing-booster but unfortunately the latest released version (currently 1.7.0) has a serious bug which causes a crash when using ibus-typing-booster. To fix this bug you need my patch from the upstream git repository (Patch also discussed here and here). Some distributions like Fedora >= 23 already have this patch, some don’t. For Debian there is this bugreport requesting to include the patch.

To run ibus-typing-booster, the following software is required or optional for additional features:

Fedora

Required:

Optional:

openSUSE

Required:

Optional:

Ubuntu 20.04

Required:

Optional: