Hanabi/Py-Hanabi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README with usage

Browse Source
This commit is contained in:
Maximilian Keßler 2023-07-05 21:09:18 +02:00
parent 37a342e63d
commit 8f0ff1ecb2
Signed by: max
GPG Key ID: BCC5A619923C0BA5
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -50,8 +50,20 @@ pip install -r requirements.txt
### PostgreSQL
You need to install PostgreSQL on your system, for installation instructions refer to your distribution.
Create a new database and user
Create a new database and user, put the connection parameters in a config file (see below).
This should be at your system default for the application `hanabi-suite`,
on POSIX systems this should be `~/.config/hanabi-suit/config.yaml`.
For the format, see the example config file.
## Usage of stuff that already works:
Use the `hanabi_suite.py` CLI interface to download games and analyze them.
An initial setup might look like this:
```
hanabi_cli.py gen-config // Generates configuration file for DB connection parameters and prints its location
<Edit your configuration file>
hanabi_cli.py init // Initializes database tables
hanabi_cli.py download --var 0 // Donwloads information on all 'No Variant' games
hanabi_cli.py analyze --download <game id> // Downloads and analyzes game from hanab.live
```