Rename to StartRNR

We're pivoting, baby!
This commit is contained in:
Kiana Sheibani 2023-10-03 23:37:51 -04:00
parent ad6445bcd2
commit d3459346f7
Signed by: toki
GPG key ID: 6CB106C25E86A9F7
8 changed files with 45 additions and 51 deletions

View file

@ -6,7 +6,7 @@ In order to access start.gg's API, you must first have an authentication token
linked to your account. Instructions for generating one can be found in the
[developer API docs](https://developer.start.gg/docs/authentication).
Once you have an auth token, it must be provided to StartGGElo. In order, the
Once you have an auth token, it must be provided to StartRNR. In order, the
program checks for a token in:
- A command-line flag `--auth`.
@ -14,22 +14,25 @@ program checks for a token in:
- A file `auth.txt` within the config directory (see the [[README]] for a list
of directories in each OS).
The last method is recommended, as StartRNR can simply read from that file
whenever it needs to.
## Step 2: Dependencies
StartGGElo is written in Rust, so install the [Rust
StartRNR is written in Rust, so install the [Rust
compiler](https://www.rust-lang.org/tools/install).
In addition, StartGGElo needs these run-time dependencies:
In addition, StartRNR needs these run-time dependencies:
- [OpenSSL](https://www.openssl.org/)
- [SQLite](https://www.sqlite.org/)
## Step 3: Compiling
Once you have all the necessary dependencies, build and install StartGGElo by
Once you have all the necessary dependencies, build and install StartRNR by
running the following command:
``` sh
cargo install --git https://github.com/kiana-S/StartGGElo
cargo install --git https://github.com/kiana-S/StartRNR
```