aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2024-07-08 19:17:51 -0500
committerChristian Cleberg <hello@cleberg.net>2024-07-08 19:17:51 -0500
commit1ce0cfaca611c6ef85ddacc15227252ccfe058e3 (patch)
tree49cda3f479b5cfe0286494e33fcfcc331bccf57c /README.md
parent2c8cb35ab1994caa9a76fec14ba12c8fad724018 (diff)
downloadcleberg.net-1ce0cfaca611c6ef85ddacc15227252ccfe058e3.tar.gz
cleberg.net-1ce0cfaca611c6ef85ddacc15227252ccfe058e3.tar.bz2
cleberg.net-1ce0cfaca611c6ef85ddacc15227252ccfe058e3.zip
convert README back to markdown
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.