From fae735d29bab21fd8163f653a6b9809e136b71d9 Mon Sep 17 00:00:00 2001 From: Kiana Sheibani Date: Fri, 13 Oct 2023 18:15:10 -0400 Subject: [PATCH] Update README --- INSTALL.md | 6 +++--- README.md | 13 ++++++++----- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 524d351..b889b9d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -11,8 +11,8 @@ program checks for a token in: - A command-line flag `--auth`. - An environment variable `AUTH_TOKEN`, -- A file `auth.txt` within the config directory (see the [[README]] for a list - of directories in each OS). +- A file `auth.txt` within the config directory (see the [README](README.md) 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. @@ -20,7 +20,7 @@ whenever it needs to. ## Step 2: Dependencies 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: diff --git a/README.md b/README.md index 330979a..4e29ed8 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ rankings automatically. **All of these features work for any game, in any region, without restriction.** > **Warning**
-> 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 @@ -39,9 +42,9 @@ StartRNR stores its rating databases in its config directory, which is located a - MacOS: `~/Library/Application Support/startrnr` - Linux: `~/.config/startrnr` -There are few reasons to access this directory directly, but you can if you want to transfer your -datasets between computers. +This directory can be used to store the authentication token, which is required +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).*