From 05c3687ab15b6236533ef88fb1c8cffd79884126 Mon Sep 17 00:00:00 2001 From: Přemysl Eric Janouch Date: Sun, 21 Jan 2024 12:41:35 +0100 Subject: gallery: use AsciiDoc for the README --- README | 14 -------------- README.adoc | 17 +++++++++++++++++ 2 files changed, 17 insertions(+), 14 deletions(-) delete mode 100644 README create mode 100644 README.adoc diff --git a/README b/README deleted file mode 100644 index 378124d..0000000 --- a/README +++ /dev/null @@ -1,14 +0,0 @@ -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. 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. -- cgit v1.2.3-70-g09d2