.. _install: ==================== Installation ==================== .. contents:: Contents :local: :depth: 2 Technetium is distributed as a single binary, ``tech``. Pre-built binaries for MacOS and Linux are available untagged on each commit on `the github actions page `_ as artifacts (Github doesn't allow you to download these artifacts, to my great displeasure), or versioned on `the release page `_. If neither of these work, luckily rust makes building very easy! Building -------- To build, make sure you have cargo and rust installed. If not, follow `these instructions `_ to install rustup and cargo. Next, navigate to the root directory of the project. Run ``cargo install --path .``. This will build the entire project and place the resulting binary (``tech``) in your path. To build this documentation, first install sphinx-build using `the instructions here `_. Then, run ``build_docs.sh`` from the main directory.