diff options
author | Přemysl Eric Janouch <p@janouch.name> | 2024-01-21 12:41:35 +0100 |
---|---|---|
committer | Přemysl Eric Janouch <p@janouch.name> | 2024-01-21 12:43:27 +0100 |
commit | 05c3687ab15b6236533ef88fb1c8cffd79884126 (patch) | |
tree | 90784083f730fb2435458c17060b2c99c995f594 /README.adoc | |
parent | aa65466a49edb68993618769d926a793aea5ad76 (diff) | |
download | gallery-05c3687ab15b6236533ef88fb1c8cffd79884126.tar.gz gallery-05c3687ab15b6236533ef88fb1c8cffd79884126.tar.xz gallery-05c3687ab15b6236533ef88fb1c8cffd79884126.zip |
gallery: use AsciiDoc for the README
Diffstat (limited to 'README.adoc')
-rw-r--r-- | README.adoc | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..dbfa4a7 --- /dev/null +++ b/README.adoc @@ -0,0 +1,17 @@ +gallery +======= + +This is 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 v7, 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. |