Trim README config example
Remove the verbose defaults snippet and add a brief localisation note pointing to the language setting.
This commit is contained in:
parent
1008be8853
commit
062f5fa7f1
21
README.md
21
README.md
|
|
@ -38,24 +38,6 @@ The launcher copies Tcl/Tk resources into the virtualenv on first run, so no man
|
||||||
5. Move through folder images with `⬅️` / `➡️`; exclusions stay put unless you opt into automatic resets.
|
5. Move through folder images with `⬅️` / `➡️`; exclusions stay put unless you opt into automatic resets.
|
||||||
6. Save an overlay (`💾`) when ready.
|
6. Save an overlay (`💾`) when ready.
|
||||||
|
|
||||||
## Config Defaults
|
|
||||||
Optional `config.toml`:
|
|
||||||
```toml
|
|
||||||
[language]
|
|
||||||
language = "en" # match files in app/lang (en, de)
|
|
||||||
|
|
||||||
[options]
|
|
||||||
reset_exclusions_on_image_change = false
|
|
||||||
|
|
||||||
[defaults]
|
|
||||||
hue_min = 250.0
|
|
||||||
hue_max = 310.0
|
|
||||||
sat_min = 15.0
|
|
||||||
val_min = 15.0
|
|
||||||
val_max = 100.0
|
|
||||||
alpha = 120
|
|
||||||
```
|
|
||||||
|
|
||||||
## Project Layout
|
## Project Layout
|
||||||
```
|
```
|
||||||
app/
|
app/
|
||||||
|
|
@ -67,6 +49,9 @@ config.toml # optional defaults
|
||||||
main.py # entry point
|
main.py # entry point
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Localisation
|
||||||
|
- English and German translations ship in `app/lang`. Set the desired language via the top-level `language` key in `config.toml`.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
- Quick check: `uv run python -m compileall app main.py`
|
- Quick check: `uv run python -m compileall app main.py`
|
||||||
- Contributions welcome; include screenshots for UI tweaks.
|
- Contributions welcome; include screenshots for UI tweaks.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue