From 4a766c7043de9078444e0c613fa8d64d802ff59c Mon Sep 17 00:00:00 2001 From: Junwoo Hwang Date: Thu, 22 Jun 2023 15:08:45 +0900 Subject: [PATCH] README: Make database setup more visible / mandatory (#250) - Previously, it wasn't so obvious that it was a ncessary step, as it was occluded by the not-necssary user settings description --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a119812bd..d762ae1cb 100644 --- a/README.md +++ b/README.md @@ -59,15 +59,21 @@ git submodule update --init --recursive ### Setup +Initialize the Database as following: + +```bash +./app/setup_db.py +``` + +**Note:** `setup_db.py` can also be used to upgrade the database tables, for instance when new entries are added (it automatically detects that). + +#### Settings + - By default the app will load `config_default.ini` configuration file - You can override any setting from `config_default.ini` with a user config file `config_user.ini` (untracked) - Any setting on `config_user.ini` has priority over `config_default.ini` -- Run `setup_db.py` to initialize the database. - -**Note:** `setup_db.py` can also be used to upgrade the database tables, for - instance when new entries are added (it automatically detects that). ## Usage