Update README.md

This commit is contained in:
Kiana Sheibani 2023-08-27 00:19:07 -04:00
parent 4f1b7f0e14
commit 41475046ed
Signed by: toki
GPG key ID: 6CB106C25E86A9F7

View file

@ -6,7 +6,7 @@ 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**
> **Note**<br>
> StartGGElo is still under development; currently, it only supports generating player ratings.
## Installation
@ -18,11 +18,12 @@ TODO
StartGGElo stores its rating database in its config directory, which is located at:
- Windows: `%APPDATA%\Roaming\ggelo`
- Mac/Linux: `~/.config/ggelo` or `~/.ggelo`
- MacOS: `~/Library/Application Support/ggelo`
- Linux: `~/.config/ggelo`
This directory also contains StartGGElo's config file, which defines how it calculates its ratings.
This file does not need to be edited directly, but it can be if you want to transfer your ratings between
computers.
There are few reasons to access this directory directory, but you can if you want to transfer your
data between computers.
## Elo system basics