summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0e0b3e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# krz.sh
+
+Source for [krz.sh](https://krz.sh) — the krazy warez website. Built with
+[Zola](https://www.getzola.org/).
+
+## Develop
+
+```sh
+zola serve
+```
+
+Then open http://127.0.0.1:1111.
+
+## Build
+
+```sh
+zola build
+```
+
+Output is written to `public/`.
+
+## Structure
+
+- `config.toml` — site configuration
+- `content/` — pages (home, `services/`, `apps/`, `about/`)
+- `templates/` — Tera templates
+- `sass/main.scss` — styles (compiled to `main.css`)
+- `static/` — assets, `favicon.svg`, and `CNAME`
+
+## Deploy
+
+Pushing to `main` builds and publishes to GitHub Pages via
+`.github/workflows/deploy.yml`. The custom domain is set in `static/CNAME`.