Skip to content

Commit

Permalink
Update readme with better install directions
Browse files Browse the repository at this point in the history
  • Loading branch information
GreatGodApollo committed Mar 22, 2020
1 parent 33335f9 commit fb849e8
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ Quick Script Runner (qsr) is a command line utility program that allows users to
* [Cobra](github.com/spf13/cobra)
* [Chalk](github.com/ttacon/chalk)

## Install

At the moment, you'll have to manually build the executable from the source, although this shouldn't be hard.
## Compiling

To compile the executable from the source, it's extremely easy, and can be done in as little as 3 commands.

You can follow these instructions to build:
```bash
Expand All @@ -29,6 +30,13 @@ $ go build

```


## Installing

Just head on over to the [releases](https://github.com/GreatGodApollo/qsr/releases) page and download the latest release
for your platform. Extract it using something like [7-Zip](https://www.7-zip.org) for Windows or `tar` on other
platforms (`tar -zxvf qsr*.tar.gz`).

That's it! Although you'll probably want to also add the binary to your path for ease of use.

## Usage
Expand Down

0 comments on commit fb849e8

Please sign in to comment.