Installation

There are two main ways to install this program, which are as follows.

This is the simplest, but can cause problems with modern versions of some operating systems, such as recent versions of macOS.

To install by this method, download and run the appropriate file from below:

These packages will take care of everything for you, though the Windows installer and AppImage does not include offline help.

If you want the most control over this program, it is recommended that you install via source.

To do so, you must have a version of the Rust toolchain that supports the 2024 edition of Rust and libclang.

Libclang is preinstalled on FreeBSD and included with the macOS developer tools.

Once you have those tools, you can then run either:

cargo build --release

Or, if you have just:

just build

Cargo is the best to use, as it will work on any operating system that has access to the Rust toolchain.

Once it is done building, you can move files into their appropriate places or use:

sudo just install

However, installing via Just is only guaranteed to work on operating systems other than Windows, as Windows users dont generally compile software.

After installing, everything should be good to go.