summaryrefslogtreecommitdiff
path: root/bin/README.md
blob: 52593e9dec6e458d9cb3373e476933cdec9c636f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 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                      |
| `vpsbackup`      | (standalone)               | restic, rsync, ssh                      |

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.
`vpsbackup.timer` and `.service` likewise run `~/.local/bin/vpsbackup`, which
pulls the VPS here daily; `vpsbackup help` covers its setup and restores.

`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.