# Installing Subplot

The Subplot project currently supports three installation methods:

* A Debian package (`deb`).
* NixOS.
* Building from source.

## Debian

The Subplot project CI builds a `deb` package for every change to the
`main` branch and publishes it on the APT repository on `apt.liw.fi`. The
`install-debian.sh` script adds the repository to APT sources lists, and
installs the package. See the script for detailed steps. You can also download
the `deb` directly, although that bypasses the checks on repository validity
that APT does.

# NixOS

We expose Subplot as a package called `subplot` in the flake provided
in this repository. You can therefore try Subplot simply by doing:

`nix shell git+https://radicle.subplot.tech/subplot.git#subplot`

# Build from source

To build and install Subplot from source, you need the
Rust toolchain. Get that from your operating system or from
<https://rust-lang.org/tools/install/>.

To install the latest released version from `crates.io`:

~~~
cargo install --locked subplot-bin
~~~

To install the current source tree:

~~~
cargo install --path=bin
~~~

In both cases Subplot is installed in the default location for `cargo
install`. Run `cargo install -h` to see documentation on options, including
`--root` to change where to install.
