toki/StartRNR
1
0
Fork 0
Code Issues Pull requests Activity

docs: reorganize README and INSTALL files

Browse source
This commit is contained in:
Kiana Sheibani 2024-08-14 20:45:22 -04:00
parent 4ef7f5adef
commit 6460947ace
Signed by: toki
GPG key ID: 6CB106C25E86A9F7
2 changed files with 13 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -34,6 +34,8 @@ Alternatively, if you use Nix:
nix profile install github:kiana-S/StartRNR
```
You will need to provide a start.gg API token to access tournament data. Details can be found in [INSTALL.md](INSTALL.md).
## Usage
Once StartRNR is installed, run:
@ -58,17 +60,6 @@ startrnr player matchup <player1> <player2>
A player can be specified by their tag or by their
[discriminator](https://help.start.gg/en/articles/4855957-discriminators-on-start-gg).
## Configuration
StartRNR stores its rating databases in its config directory, which is located at:
- Windows: `%APPDATA%\Roaming\startrnr`
- MacOS: `~/Library/Application Support/startrnr`
- Linux: `~/.config/startrnr`
This directory can be used to store the authentication token, which is required
for using StartRNR.
## Details - The RNR System
*For more information on RNR, see the [details page](DETAILS.md).*