# Installing elfshaker

## Using pre-built binaries
1. Grab the latest `elfshaker-Release-[arch].tar.gz` from [Releases](https://github.com/elfshaker/elfshaker/releases).

2. Extract to any location you would like and add the directory to your path:
```bash
mkdir -p ~/.local/opt && mkdir -p ~/.local/bin && tar -xf "elfshaker-Release-$(uname -m).tar.gz" -C ~/.local/opt && ln -s ~/.local/opt/elfshaker/bin/elfshaker ~/.local/bin/elfshaker
```
<details>
  <summary>Formatted version of the above one-liner</summary>

```bash
mkdir -p ~/.local/opt
mkdir -p ~/.local/bin
tar -xf "elfshaker-Release-$(uname -m).tar.gz" -C ~/.local/opt
ln -s ~/.local/opt/elfshaker/bin/elfshaker ~/.local/bin/elfshaker
```
</details>

**Please, make sure to add `~/.local/bin` to your PATH environment variable.**

*[How to add directory to PATH?](https://askubuntu.com/questions/60218/how-to-add-a-directory-to-the-path)*

## Building from source

elfshaker is written in Rust, so you will need to install the Rust build system.
- Install using rustup from https://www.rust-lang.org/tools/install
- Install toolchain version 1.52.1 (any version supporting Rust 2018 should work)
  - ```bash
    rustup install 1.52.1
    ```
- Build elfshaker in Release mode
  - ```bash
    cargo +1.52.1 build --release --bin elfshaker
    ```
  - ```bash
    ./target/release/elfshaker --help
    ```