From ab723a1ebe84ce95643d19241872dd43f3714d15 Mon Sep 17 00:00:00 2001 From: Přemysl Eric Janouch Date: Sat, 23 Dec 2023 09:20:47 +0100 Subject: Add a README --- README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..375dcdf --- /dev/null +++ b/README @@ -0,0 +1,14 @@ +This is a gallery software designed to maintain a shadow structure +of your filesystem, in which you can attach metadata to your media, +and query your collections in various ways. + +All media is content-addressed by its SHA-1 hash value, and at your option +also perceptually hashed. Duplicate search is an essential feature. + +Prerequisites: Go, ImageMagick, xdg-utils + +The gallery is designed for simplicity, and easy interoperability. +sqlite3, curl, jq, and the filesystem will take you a long way. + +The intended mode of use is running daily automated sync/thumbnail/dhash/tag +batches in a cron job, or from a system timer. See test.sh for usage hints. -- cgit v1.2.3-70-g09d2