add README.md

This commit is contained in:
tcprod 2026-03-21 17:39:11 +01:00
parent 63df4b7edd
commit 0d8daf15ad
4 changed files with 18 additions and 0 deletions

View File

@ -0,0 +1,13 @@
### Step 1: Preparing configuration
Prepare the `config.toml` at the base of the repository. It is important to adjust the database configuration as well as the `browser_path`.
### Step 2: Install dependencies
Use `pip install -r requirements.txt` to install the requirements. The usage of a venv is recommended.
### Further
![activity diagram](activity_diagram.svg)

4
activity_diagram.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 9.8 KiB

View File

@ -11,6 +11,7 @@ async def main():
badges = await db.get_user_badges()
badge_generator = BadgeGeneratorService("config.toml")
for user_badge in badges:
badge_generator.generate_badge(
user_name=user_badge["user_name"],

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB