Skip to content

Commit d9627df

Browse files
committed
added minimal usage in readme
1 parent 6f9fe5b commit d9627df

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

doc/images/main_window.jpg

289 KB
Loading

readme.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,26 @@ This project is a little tool written in python and QT to change and view IPTC i
1111

1212
## Creating binaries with PyInstaller
1313
run ```pyinstaller Graphis_pyinstaller.spec``` to create an executable software package graphis_XX.
14+
15+
## Usage
16+
The tool aims to add or manipulate IPTC image regions. Defined geometries within the IPTC image regions are
17+
Circles/Rectangles/Polygons. These geometries can be created/moved/changed. Only geometries within
18+
the image area are allowed as well polygons have to be valid to be saved. Additional extra meta information
19+
can be stored for each image region.
20+
21+
While currently only fixed meta fields of the image region can be edited, all meta information wihtin the
22+
image regions can be shown with the tabs on the right side called "View region info" to show the region info of the current selected geometry
23+
and "All region info" which shows all image region within the current image.
24+
25+
Currently, all images supported by "PySide6" and "rawpy" can be imported. For importing and saving metadata
26+
"exiftool (https://exiftool.org/)" is used.
27+
28+
Right-Click: Create new image region. Polygon is finished by left click.
29+
Moving geometries. Change geometrie by right-click on the nearest vertices or the circle border
30+
31+
Changes are submitted to the project's sqlite file. Geometry creation/changes are submitted to the database immediately,
32+
while metadata changes on the right have to be submitted by the save button
33+
To update the image's metadata use the menu on top "save image regions to file"
34+
35+
36+
![ ](doc/images/main_window.jpg)

0 commit comments

Comments
 (0)