aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..04d6df3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+* cleberg.net
+
+[cleberg.net](https://cleberg.net) is my personal webpage and blog.
+
+** Overview
+
+This website & blog uses Markdown for content, HTML for templates, built and
+published with [Zola](https://getzola.org).
+
+** Configuration
+
+All configuration options are available within the =config.toml= file. Refer to
+the Zola documentation for further configuration options.
+
+** Building
+
+To get running:
+
+```sh
+git clone https://git.sr.ht/~cyborg/cleberg.net && \
+cd cleberg.net && \
+zola build
+```
+
+** Publishing
+
+Use `zola build` and deploy to whichever deployment target you prefer.
+
+** Tasks
+
+Refer to the [todo page](https://todo.sr.ht/~cyborg/cleberg.net) for open
+tickets or to submit a new ticket.