config readme appendum

This commit is contained in:
Jill 2023-01-06 13:03:22 +03:00
parent 285ed7647c
commit 84b782e8cd
1 changed files with 5 additions and 1 deletions

View File

@ -28,10 +28,14 @@ additionally, the lack of configuration compelled me even more to write my own s
`shards install` && `shards build`
## setup
## configuration
copy `.env.example` to `.env` and fill it out, same for `config.example.toml` -> `config.toml`
by default, the config emulates vanilla GD servers as closely as possible, but you'll likely want to change it - most options have comments detailing what exactly they do
## setup
run `bin/crystal-gauntlet migrate` (or `shards run -- migrate`)
**schemas are highly unstable so you will be offered 0 support in migrating databases for now**, however in the future you'll want to run this each time you update