diff --git a/README.md b/README.md index 17725e7..4a94aea 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,19 @@ source .venv/bin/activate # if .venv missing: python3 -m venv .venv && mkdocs serve # http://127.0.0.1:8000 with live reload ``` +## Publishing + +The repo is initialised but not yet pushed to a remote. To publish: + +```bash +git remote add origin +git push -u origin main +``` + +Once the repo lives at a GitHub URL with Pages enabled (Settings → Pages +→ Source: GitHub Actions), the workflow at `.github/workflows/publish.yml` +will build and deploy the static site on every push to `main`. + ## Out-of-scope - The B2B printing-platform layer (`plat_*` tables, `xlyPlat*` modules).