Skip to content

Commit

Permalink
README: Make database setup more visible / mandatory (#250)
Browse files Browse the repository at this point in the history
- Previously, it wasn't so obvious that it was a ncessary step, as it
  was occluded by the not-necssary user settings description
  • Loading branch information
junwoo091400 authored Jun 22, 2023
1 parent 62b7590 commit 4a766c7
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 4a766c7

Please sign in to comment.