Update README for new features

Document freehand exclusions, persistent shapes, and new config options (language, exclusion reset).
This commit is contained in:
lm 2025-10-17 17:33:15 +02:00
parent 1d0acba3c3
commit 1008be8853
1 changed files with 15 additions and 7 deletions

View File

@ -9,10 +9,10 @@
## Features
- Two synced previews (original + overlay)
- Hue/Sat/Value sliders with presets and image colour picker
- Exclusion rectangles to ignore regions
- Theme toggle (light/dark) with rounded toolbar buttons
- Folder support with previous/next navigation
- Quick overlay export (PNG) and optional defaults via `config.toml`
- Exclusion rectangles or freehand polygons that persist while browsing
- Theme toggle (light/dark) with rounded toolbar buttons and accent-aware highlights
- Folder support with wrap-around previous/next navigation
- Quick overlay export (PNG) with configurable defaults and language settings via `config.toml`
## Requirements
- Python 3.11+ (3.10 works with `tomli`)
@ -34,12 +34,19 @@ The launcher copies Tcl/Tk resources into the virtualenv on first run, so no man
1. Load an image (`📂`) or a folder (`📁`).
2. Pick a colour (`🎨` dialog, `🖱️` image click, or preset swatch).
3. Finetune sliders; watch the overlay update on the right.
4. Move through folder images with `⬅️` / `➡️`.
5. Draw exclusions with right drag; reset or save when ready.
4. Toggle freehand mode (`△`) or stick with rectangles and mark areas to exclude (right mouse drag).
5. Move through folder images with `⬅️` / `➡️`; exclusions stay put unless you opt into automatic resets.
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
@ -54,7 +61,8 @@ alpha = 120
app/
app.py # main app assembly
gui/ # UI, theme, picker mixins
logic/ # image ops, defaults, reset
logic/ # image ops, defaults, config helpers
lang/ # localisation TOML files
config.toml # optional defaults
main.py # entry point
```