summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2024-05-09 07:32:03 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2024-05-09 07:32:03 +0200
commit7fad983b10f338d48a1385c1ae59cb3e2444e9d8 (patch)
tree963532a387394bc9a6209729c12efe906a062e0d
parent9496e49dea54e07b7af02d714bcdf532032d951f (diff)
Extend README
-rw-r--r--README.md32
1 files changed, 22 insertions, 10 deletions
diff --git a/README.md b/README.md
index 47b94ba..16e57a9 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,36 @@
pyggle – Python Image Gallery for Static Websites
---
-**pyggle** generates a static image gallery with javascript lightbox and a bit
-of EXIF data for web hosting. It aims to do one thing well and not do anything
-else.
+**pyggle** generates a static HTML image gallery from filenames passed on the
+command line. It aims to do this one thing well and does not support anything
+else. Features include:
+
+* chronological sorting of images via EXIF or filesystem timestamps
+ (`--sort`, `--reverse`)
+* Grouping images by day/month/year
+ (`--group`, `--group-files`)
+* Reverse geocoding to add place names and OpenStreetMap links to image details
+ (`--with-nominatim`, `--nominatim-zoom`)
+* Altering images for publication – note that these edit all files in place
+ (`--scrub-metadata`, `--resize`, `--exif-copyright`)
## Demo
-See [lib.finalrewind.org](https://lib.finalrewind.org/Wildpark%20Bilsteintal%202020/).
+See the galleries linked from
+[finalrewind.org/pics](https://finalrewind.org/pics/).
## Usage
-There's no proper Python package yet. Clone the git repository and run pyggle
-from the directory you want to have the gallery in, while passing it some
-image files. I.e.:
+There is no Python package and thus no installation process.
+
+Clone the git repository and run pyggle from the directory you want to have the
+gallery in, while passing it some image files. I.e.:
```
cd /some/directory
-/another/directory/pyggle/bin/pyggle *.jpg
+/another/directory/python-image-gallery/bin/pyggle *.jpg
```
-pyggle does not support recursion. All images must be located in the current
-working directory.
+See `pyggle --help` for a list of options.
+
+All image files must be located in or below the current working directory.