jlay/dot
1
0
Fork 0
Code Pull requests Activity

readme: no more expandables, accessibility/brevity

Browse source
This commit is contained in:
Josh Lay 2024-06-20 16:55:46 -05:00
parent c321b2c28c
commit 021d051e70
No known key found for this signature in database
GPG key ID: 47AA304B2243B579
1 changed files with 37 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

83
README.md
View file

@ -9,57 +9,48 @@ _I use Fedora btw :)_
### i3/Sway auto-start script ### i3/Sway auto-start script
<details> Time/date aware autostart manager. The script: [.config/sway/scripts/startup.py](./outerheaven.init3.home/.config/sway/scripts/startup.py)
<summary><i>Click to expand...</i></summary>
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.
</details> 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 ### homedir backup script
<details> File: [~/.local/bin/backup_home](./outerheaven.init3.home/.local/bin/backup_home)
<summary><i>Click to expand...</i></summary>
Intended as part of the auto-starts above, I have [written a script](./outerheaven.init3.home/.local/bin/backup_home) This will back up `$HOME`_(minus exclusions, of course)_; part of [the auto-starts]
to back up `$HOME` (#i3sway-auto-start-script)
_(minus exclusions, of course)!_
The meaningful work is given away to other utilities: The meaningful work is given away, coordinating _[on-login]_:
* `restic`: performs the backup * `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
</details>