Installation

There are multiple ways to install Afrim input method. Choose any one of the methods below that best suit your needs.

Pre-compiled binaries

Executable binaries are available for download on the Github Releases page. Download the binary for your platform (Windows, macOS, or Linux) and extract the archive. The archive contains an afrim executable.

To make it easier to run, put the path to the binary into your PATH.

Build from source using Rust

To build afrim executable from source, you will first need to install Rust and Cargo. Follow the instructions on the Rust installation page. Afrim currently requires at least Rust version 1.7 for performance.

Once you have installed Rust, the following command can be used to build and install afrim:

cargo install afrim

This will automatically download afrim from crates.io, build it, and install it in Cargo's global binary directory (~/.cargo/bin/ by default).

To uninstall, run the command cargo uninstall afrim.

Installing the latest master version

The version published to crates.io will ever so slightly be behind the version hosted on GitHub. If you need the lastest version, you can build the git version of afrim yourself. Cargo makes this super easy!

cargo install --git https://github.com/pythonbrad/afrim.git afrim

Again, make sure to add the Cargo bin directory to your PATH.

If you are interested in making modifications to afrim itself, checkout the Contributing Guide for more information.