Skip to content

Commit

Permalink
feat: add install instruction
Browse files Browse the repository at this point in the history
BREAKING CHANGE: Finalize release, even though this is a docs change.
  • Loading branch information
m-triassi committed Dec 20, 2023
1 parent ac572f3 commit e310614
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,30 @@ WoWForge-CLI is an simple command line utility for Linux that can be used to tra
## Installation
Currently pre-built binaries are available for download in the repositories [releases](https://github.com/m-triassi/wowforge-cli/releases) page. Simply download a release and follow the guidance below.

First ensure that the downloaded binary is executable:
### Linux

Pick the correct file for your current distribution and architecture and download it.

For example if you are on Ubuntu, download the `wowforge-cli_x.x.x_amd64.deb` file where `x.x.x` is the latest release version
and run the following:

```bash
sudo chmod +x /path/to/wowforge-cli
sudo apt install ./wowforge-cli_x.x.x_amd64.deb
```

Then, simply move the built application to any folder in your `PATH`, like `/usr/local/bin` or `/home/MYUSER/.local/bin` depending on your system, and personal setup.
Once complete you may run `wowforge-cli` globally.

### MacOS

Alternatively you can make a new directory somewhere and append that directory to your `PATH`, like so:
`wowforge-cli` is distributed via [brew](https://brew.sh/), you can install the latest version of the application by adding the tap, and installing
the application.

```bash
mkdir /my/custom/path
mv ~/Downloads/wowforge-cli /my/custom/path
echo "export PATH=\"$PATH:/my/custom/path\"" >> ~/.bashrc
source ~/.bashrc
brew tap m-triassi/public
brew install wowforge-cli
```

Finally you can also just keep the binary in a specific file and specify the full path to it when ever you want to use it, like so: `./my/path/to/wowforge-cli <command>`
Once complete you may run `wowforge-cli` globally.

### Set up
Before being able to use application you **must** set the install path configuration value. This path specifies where
Expand Down

0 comments on commit e310614

Please sign in to comment.