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

Update README

Browse source
This commit is contained in:
Kiana Sheibani 2023-10-13 18:15:10 -04:00
parent 71b81789f3
commit fae735d29b
Signed by: toki
GPG key ID: 6CB106C25E86A9F7
2 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
INSTALL.md
View file

@ -11,8 +11,8 @@ program checks for a token in:
- A command-line flag `--auth`. - A command-line flag `--auth`.
- An environment variable `AUTH_TOKEN`, - An environment variable `AUTH_TOKEN`,
- A file `auth.txt` within the config directory (see the [[README]] for a list - A file `auth.txt` within the config directory (see the [README](README.md) for
of directories in each OS). a list of directories in each OS).
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.
@ -20,7 +20,7 @@ whenever it needs to.
## Step 2: Dependencies ## Step 2: Dependencies
StartRNR 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). toolchain](https://www.rust-lang.org/tools/install).
In addition, StartRNR needs these run-time dependencies: In addition, StartRNR needs these run-time dependencies:

13
README.md
View file

@ -13,7 +13,10 @@ rankings automatically.
**All of these features work for any game, in any region, without restriction.** **All of these features work for any game, in any region, without restriction.**
> **Warning**<br> > **Warning**<br>
> StartRNR is still under development; currently, it only supports generating the network. > StartRNR is unstable and under active development. The design and user
> interface of this program is experimental and may be subject to change.
>
> Currently, only generating datasets has been implemented.
## Installation ## Installation
@ -39,9 +42,9 @@ StartRNR stores its rating databases in its config directory, which is located a
- MacOS: `~/Library/Application Support/startrnr` - MacOS: `~/Library/Application Support/startrnr`
- Linux: `~/.config/startrnr` - Linux: `~/.config/startrnr`
There are few reasons to access this directory directly, but you can if you want to transfer your This directory can be used to store the authentication token, which is required
datasets between computers. for using StartRNR.
## RNR system basics ## Details - The RNR System
*For more information on StartRNR's rating system, see the [details page](DETAILS.md).* *For more information on RNR, see the [details page](DETAILS.md).*