Installation

Use the Normal method if you just want to try Supertag. If you’re interested in development and contributing to the project, use the Development method.

Normal

This will install the Supertag binary and set up all dependencies for you.

MacOS

The following has been tested on MacOS 10.15 (Catalina).

First, if you don’t have Homebrew installed (you should!), install it:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Now install OSXFuse. Supertag is built on the FUSE platform, and OSXFuse is MacOS’s port of it:

brew cask install osxfuse

Note

You may need to go to System Preferences -> Security & Privacy -> General and click “Allow” for “Benjamin Fleischer” to complete the installation of OSXFuse. Benjamin Fleischer is the author of OSXFuse, and OSXFuse needs to be explicitly confirmed as trusted software. Finally, you will need to reboot to enable the kernel extension, although I was able to use Supertag on a fresh Catalina without reboot. YMMV

Now you’re ready to install Supertag:

brew install amoffat/rnd/supertag

Linux

The following AppImage works on all major Linux distributions:

curl -Ls https://github.com/amoffat/supertag/releases/latest/download/supertag-x86_64.AppImage > tag
sudo install tag /usr/local/bin

Development

This will set up the Supertag repository on your computer and get the development environment ready.

Common

Whether you’re installing on MacOS or Linux, you’ll need to do the following setup.

Grab a copy of the Supertag source code from Github:

git clone https://github.com/amoffat/supertag.git

MacOS

Dependencies

Make sure you have Homebrew installed:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Now install OSXFuse. Supertag is built on the FUSE platform, and OSXFuse is MacOS’s port of it:

brew cask install osxfuse

Note

You may need to go to System Preferences -> Security & Privacy -> General and click “Allow” for “Benjamin Fleischer” to complete the installation of OSXFuse. Benjamin Fleischer is the author of OSXFuse, and OSXFuse needs to be explicitly confirmed as trusted software. Finally, you will need to reboot to enable the kernel extension, although I was able to use Supertag on a fresh Catalina without reboot. YMMV

Now install all of the necessary dependencies listed in the official Supertag formula:

brew install --only-dependencies amoffat/rnd/supertag

Linux

Dependencies

Install Rust:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Now install some basic dependencies for building:

sudo apt install \
    build-essential \
    libfuse-dev \
    pkg-config \
    clang \
    llvm \
    libsqlite3-dev \
    cmake