summary history branches tags files
commit:b7937d0fb60fa59cf8ee5df14e321a8b663438af
author:Trevor Bentley
committer:Trevor Bentley
date:Wed Jan 15 19:16:12 2025 +0100
parents:7746642133cc2873d518cc85116e46ca049681c0
readme: mention darktable lua plugin
diff --git a/README.md b/README.md
line changes: +12/-0
index cfb37c9..38b6763
--- a/README.md
+++ b/README.md
@@ -346,6 +346,18 @@ It has only been tested in Linux, but all dependencies are cross-platform so it 
 
 You should **absolutely not use this tool on photos that have not been backed up**!  It is mostly **untested** and entirely **unwarranted** and **unguaranteed** and it **should not be trusted**.
 
+
+## Darktable Plugin
+
+A minimal Lua plugin for Darktable is included, `darktable/photo-what-what.lua`.
+
+The plugin adds a single "auto-tag images (pww)" button to the "Action on Selection" menu in the Lightroom view.  Select one or more images, click auto-tag, and the process of tagging runs in the background.
+
+If necessary, paths to pww itself and the desired identifier binary/script can be configured in Darkroom's settings under the "Lua options" tab.  This is unnecessary if the `photo-what-what` binary is in your path and the identifier binary is specified in your `pww_config.toml`.
+
+Install it via Darktable's extremely user-unfriendly standard method: copy it to `~/.config/darktable/lua/contrib/photo-what-what.lua`, manually append `require "contrib/photo-what-what"` to `~/.config/darktable/luarc`, and restart Darktable.  (Paths may be different, depending on OS and configuration.)
+
+
 ## Related solutions
 
 At the time this was written (early 2025), I could not find any free solutions for local automatic content tagging with AI/ML/DL/LLMs in Linux that were compatible with my photo workflow.