From 021d051e7097b8457f3989723dac8bbbb970db83 Mon Sep 17 00:00:00 2001 From: Josh Lay Date: Thu, 20 Jun 2024 16:55:46 -0500 Subject: [PATCH] readme: no more expandables, accessibility/brevity --- README.md | 83 +++++++++++++++++++++++++------------------------------ 1 file changed, 37 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index b4038c1..06c298b 100644 --- a/README.md +++ b/README.md @@ -9,57 +9,48 @@ _I use Fedora btw :)_ ### i3/Sway auto-start script -
- Click to expand... - - Time/date aware autostart manager. The script: [.config/sway/scripts/startup.py](./outerheaven.init3.home/.config/sway/scripts/startup.py) - - This is run by Sway on-login: - - ```bash - ~ $ cat ~/.config/sway/config - # Config for sway - # - # See `man 5 sway` for a complete reference. - # [...] - # run script which handles conditional/timely autostarts. uses dict w/ this structure: - # {'autostarts': { 'pre': [], 'weekend': [], 'common': [], 'work': []}} - exec 'python3 ~/.config/sway/scripts/startup.py' - ``` - - This reads [autostart-i3ipc.yml](./outerheaven.init3.home/.config/autostart-i3ipc.yml) - _(in `~/.config`)_ to know what programs to `exec`. - - Example with in-line comments: - - ```yaml - --- - autostarts: - pre: [] # *always* run, before/blocking others. ie: backup - weekend: [] # blocking Sat/Sun. after 'pre'/before 'common'. ie: backup tier 2 - common: [] # things started every day, after 'pre' - non-blocking - work: [] # does not execute on weekends; only if within working day/hours - ``` - - Touch `~/.vacation` to skip `work` autostarts; `rm` when work may continue :) - - Working days are assumed Monday through Friday. Hours are between 8 AM and 4 PM. - These parameters may be changed in the `WorkTime` class. +Time/date aware autostart manager. The script: [.config/sway/scripts/startup.py](./outerheaven.init3.home/.config/sway/scripts/startup.py) -
+This is run by Sway on-login: + +```bash +~ $ cat ~/.config/sway/config +# Config for sway +# +# See `man 5 sway` for a complete reference. +# [...] +# run script which handles conditional/timely autostarts. uses dict w/ this structure: +# {'autostarts': { 'pre': [], 'weekend': [], 'common': [], 'work': []}} +exec 'python3 ~/.config/sway/scripts/startup.py' +``` + +This reads [autostart-i3ipc.yml](./outerheaven.init3.home/.config/autostart-i3ipc.yml) +_(in `~/.config`)_ to know what programs to `exec`. + +Example with in-line comments: + +```yaml +--- +autostarts: +pre: [] # *always* run, before/blocking others. ie: backup +weekend: [] # blocking Sat/Sun. after 'pre'/before 'common'. ie: backup tier 2 +common: [] # things started every day, after 'pre' - non-blocking +work: [] # does not execute on weekends; only if within working day/hours +``` + +Touch `~/.vacation` to skip `work` autostarts; `rm` when work may continue :) + +Working days are assumed Monday through Friday. Hours are between 8 AM and 4 PM. +These parameters may be changed in the `WorkTime` class. ### homedir backup script -
- Click to expand... +File: [~/.local/bin/backup_home](./outerheaven.init3.home/.local/bin/backup_home) - Intended as part of the auto-starts above, I have [written a script](./outerheaven.init3.home/.local/bin/backup_home) - to back up `$HOME` - _(minus exclusions, of course)!_ +This will back up `$HOME`_(minus exclusions, of course)_; part of [the auto-starts] +(#i3sway-auto-start-script) - The meaningful work is given away to other utilities: +The meaningful work is given away, coordinating _[on-login]_: * `restic`: performs the backup -* `pass`: stores the passphrase given to `restic`; prompts for confirmation on hardware token - -
+* `pass`: stores the passphrase given to `restic`; confirmation on hardware token