summaryrefslogtreecommitdiff
path: root/bin/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'bin/README.md')
-rw-r--r--bin/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/bin/README.md b/bin/README.md
new file mode 100644
index 0000000..6c32c13
--- /dev/null
+++ b/bin/README.md
@@ -0,0 +1,19 @@
+# bin/
+
+Scripts that sections of `config.org` drive. Each is a terminal program first,
+and the config looks for it on `PATH` before falling back to this directory.
+
+| Script | Used by | Needs |
+|------------------|----------------------------|-----------------------------------------|
+| `astro-transits` | Astrology | astrolog, imv (or `ASTRO_VIEWER`) |
+| `docsync` | Backups | restic, ssh, jq, notify-send |
+| `imgcollage` | Media thumbnails > Collage | Python 3, Pillow |
+| `system-theme` | Appearance > Theme | the COSMIC desktop |
+
+Each script's header or usage message (`docsync help`) says how to set it up.
+`systemd/` holds docsync's user units: copy them to `~/.config/systemd/user/`,
+put `docsync` at `~/.local/bin/docsync`, and enable the three timers.
+
+`photocollage/` is vendored unchanged from
+[PhotoCollage](https://github.com/adrienverge/PhotoCollage) by Adrien Vergé,
+and is licensed GPL-2.0-or-later, as its file headers say.