Skip to content

Commit

Permalink
Add installation instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
elescondite committed Mar 8, 2021
1 parent 1037067 commit 6645fd9
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,33 @@ tastypl is a [Go](https://golang.org/) program that imports your
statistics to help you track your performance and positions. The main
motivation behind it was to track the net credit after rolls.

NOTE: This repository is a fork of the orginal at [https://github.com/gotasty/tastypl](https://github.com/gotasty/tastypl) which has not been maintained in a while.

## Getting Started

Prerequisites: Git (https://git-scm.com/), Go (https://golang.org/)

1. Clone the repository:
```
git clone https://github.com/elescondite/tastypl.git
```
2. Install the dependencies:

```
go env -w GO111MODULE=off
go get github.com/Graeme22/go-chart
go get github.com/golang/glog
go get github.com/shopspring/decimal
```

3. Run the code on your CSV file (instructions on how to obtain below.)

```
go run tastypl.go -input yourcsvfile.csv -printpl -positions -chart
```

Note: On MacOS, the full path to the CSV file must be specified.

## Command Line Options

```
Expand Down

0 comments on commit 6645fd9

Please sign in to comment.