Update documentation
This commit is contained in:
parent
dd4f0838ab
commit
5d0fbcd107
4 changed files with 55 additions and 5 deletions
20
README.md
20
README.md
|
|
@ -6,23 +6,35 @@ generate and maintain [Elo ratings](https://wikipedia.org/wiki/Elo_rating_system
|
|||
Once Elo ratings are generated, StartGGElo can be used to generate ranking lists, predict the
|
||||
probability of a player winning a match, generate seedings for future tournaments, and more.
|
||||
|
||||
> **Note**<br>
|
||||
> **Warning**<br>
|
||||
> StartGGElo is still under development; currently, it only supports generating player ratings.
|
||||
|
||||
## Installation
|
||||
|
||||
TODO
|
||||
*For more information, see the [installation page](INSTALL.md).*
|
||||
|
||||
Build and install StartGGElo using `cargo`:
|
||||
|
||||
``` sh
|
||||
cargo install --git https://github.com/kiana-S/StartGGElo
|
||||
```
|
||||
|
||||
Alternatively, if you use Nix:
|
||||
|
||||
``` sh
|
||||
nix profile install github:kiana-S/StartGGElo
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
StartGGElo stores its rating database in its config directory, which is located at:
|
||||
StartGGElo stores its rating databases in its config directory, which is located at:
|
||||
|
||||
- Windows: `%APPDATA%\Roaming\ggelo`
|
||||
- MacOS: `~/Library/Application Support/ggelo`
|
||||
- Linux: `~/.config/ggelo`
|
||||
|
||||
This directory also contains StartGGElo's config file, which defines how it calculates its ratings.
|
||||
There are few reasons to access this directory directory, but you can if you want to transfer your
|
||||
There are few reasons to access this directory directly, but you can if you want to transfer your
|
||||
data between computers.
|
||||
|
||||
## Elo system basics
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue