install-from-source.md

Install from Source

Note that the following instructions assume a fairly "normal" file system. You may need to adjust some of the paths here to match your system.

1. Open the latest release page on Github

2. Download the source .tar.gz file

3. Install the Rust compiler

   See: https://www.rust-lang.org/tools/install

4. Extract the source code

   Before you run this, be sure to replace {version} to match the file you downloaded.

   tar xvzf {version}.tar.gz
   cd alt-{version}

5. Compile alt (This will take a while)

   cargo build --release --locked

6. Install the alt binary

   sudo cp target/release/alt /usr/local/bin/alt

7. Install the PATH configuration scripts

   sudo cp etc/profile.d/alt.sh /etc/profile.d/alt.sh
   # (Optional) if you use fish
   sudo cp etc/fish/conf.d/alt.fish /etc/fish/conf.d/alt.fish

8. (Optional) Install the completions

   # If you use BASH
   sudo cp target/release/completion/alt.bash /etc/bash_completion.d/alt.bash
   # If you use ZSH
   sudo cp target/release/completion/_alt /usr/share/zsh/site-functions/_alt
   # If you use FISH
   sudo cp target/release/completion/alt.fish /etc/fish/completions/alt.fish

9. (Optional) Install man pages

   sudo mkdir -p /usr/local/share/man/man1
   sudo cp target/release/man/* /usr/local/share/man/man1/

You will probably need to log out & log back in to your desktop session so that the PATH configuration scripts you installed will load.