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
Show stats Download patch file Download diff file Expand all files Collapse all files

20
INSTALL.md
View file

@ -9,23 +9,25 @@ linked to your account. Instructions for generating one can be found in the
Once you have an auth token, it must be provided to StartRNR. In order, the Once you have an auth token, it must be provided to StartRNR. In order, the
program checks for a token in: program checks for a token in:
- A command-line flag `--auth`. 1. A command-line flag `--auth`.
- An environment variable `AUTH_TOKEN`, 2. An environment variable `AUTH_TOKEN`,
- A file `auth.txt` within the config directory (see the [README](README.md) for 3. A file `auth.txt` within the config directory:
a list of directories in each OS). - Windows: `%APPDATA%\Roaming\startrnr/auth.txt`
- MacOS: `~/Library/Application Support/startrnr/auth.txt`
- Linux: `~/.config/startrnr/auth.txt`
The last method is recommended, as StartRNR can simply read from that file The last method is recommended, as StartRNR can simply read from that file
whenever it needs to. whenever it needs to.
## Step 2: Dependencies ## Step 2: Dependencies
StartRNR is written in Rust, so install the [Rust StartRNR requires these dependencies:
toolchain](https://www.rust-lang.org/tools/install).
In addition, StartRNR needs these run-time dependencies: - [Rust](https://www.rust-lang.org/tools/install)
- [OpenSSL](https://github.com/openssl/openssl#build-and-install)
- [SQLite](https://www.sqlite.org/download.html)
- [OpenSSL](https://www.openssl.org/) Follow the instructions to download and install each.
- [SQLite](https://www.sqlite.org/)
## Step 3: Compiling ## Step 3: Compiling

13
README.md
View file

@ -34,6 +34,8 @@ Alternatively, if you use Nix:
nix profile install github:kiana-S/StartRNR 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 ## Usage
Once StartRNR is installed, run: 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 A player can be specified by their tag or by their
[discriminator](https://help.start.gg/en/articles/4855957-discriminators-on-start-gg). [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 ## Details - The RNR System
*For more information on RNR, see the [details page](DETAILS.md).* *For more information on RNR, see the [details page](DETAILS.md).*