Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JLaferri authored Sep 25, 2019
1 parent ed73c18 commit c9d3d37
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Slippi Set Stats
This is a tool used to compute post-set stats from slp files for Melee tournaments. It is intended to be used as part of a production workflow to display post-set stats such as what was done at Mainstage 2019.

![image](https://user-images.githubusercontent.com/1534726/65564174-e8c92080-df00-11e9-9805-bfc83638f19d.png)
## Usage
1. Download executable for your operating system from the Releases tab
1. Download executable for your operating system from the [Releases](https://github.com/JLaferri/slippi-set-stats/releases) tab
2. Move slp files from the same set to the folder containing the executable
3. Run the executable, will generate an output.json file with the stats
## Limitations
Expand All @@ -10,4 +12,4 @@ This is a tool used to compute post-set stats from slp files for Melee tournamen
## Build Instructions
1. Install node 10.15.3
2. Install pkg using `npm i pkg -g`
3. Run `npm build` from the root of the repo
3. Run `npm build` from the root of the repo

0 comments on commit c9d3d37

Please sign in to comment.