summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsillylaird <sillylaird@fastmail.ca>2026-02-03 21:27:57 -0500
committersillylaird <sillylaird@fastmail.ca>2026-02-03 21:27:57 -0500
commit720d752748b793a2f5cf3cc14cb75ad86e8919c0 (patch)
tree29120103307cb17e7d6c283cc198ec2484f934cd /README.md
First commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e9e1b2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# www.sillylaird.ca
+
+Static personal site: HTML + CSS + a little JS. No build step.
+
+## Common maintenance
+
+- `python3 tools/link_check.py` — internal link sanity check
+- `python3 tools/html_audit.py` — quick a11y/markup audit
+- `python3 tools/generate_sitemap.py` — rebuild `sitemap.xml`
+- `python3 tools/translate_pages.py` — generate missing `*_zh.html`/`*_jp.html`
+
+## Ops helpers
+
+- `./tools/backup.sh` — tarball backup (defaults to `/tmp/www.sillylaird.ca-backups`, override with `BACKUP_DIR`)
+- `./tools/uptime_check.sh` — curl-based uptime check (override target with `URL`)
+
+Example cron entries:
+
+```cron
+# nightly backup at 03:15 UTC
+15 3 * * * BACKUP_DIR=/var/backups/www.sillylaird.ca /path/to/tools/backup.sh
+
+# hourly uptime check
+0 * * * * URL=https://www.sillylaird.ca/ /path/to/tools/uptime_check.sh
+```
+
+## Notes
+
+- `sitemap.xml` is generated by `tools/generate_sitemap.py`.
+- Shared header/footer live in `partials/` and are injected by `assets/js/includes.js`.