Skip to content

Commit

Permalink
Expand use instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jpsingleton committed Jun 1, 2020
1 parent 6a64050 commit 97a7b73
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,15 @@ Paid most for electricity between Sat 23 May 14:30 and Sat 23 May 15:00 (-12.327

## Use

Download a pre-built self-contained binary from the releases page.
Download a pre-built self-contained binary from the releases page and decompress it to a folder.
Change directory to the folder in a command prompt.

Run the app in a terminal specifying the [region ID character](https://en.wikipedia.org/wiki/Distribution_network_operator#History) for the area you are interested in.

E.g. `octoplot j` for South East England.
Run the app in your terminal specifying the [region ID character](https://en.wikipedia.org/wiki/Distribution_network_operator#History) for the area you are interested in.
E.g. `./octoplot j` for South East England.
The default value is `P` (North Scotland).

Add the folder to your `PATH` if you want to run `octoplot` from anywhere.

### Regions

These are the [region codes](api/Region.cs):
Expand Down

0 comments on commit 97a7b73

Please sign in to comment.