aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md30
1 files changed, 27 insertions, 3 deletions
diff --git a/README.md b/README.md
index 15c8ac1..03c9c58 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,30 @@
# blog
-Personal blog currently hosted on [blog.memzero.de](https://blog.memzero.de).
+This repository contains the sources that make up my personal blog, which is
+currently hosted at [blog.memzero.de](https://blog.memzero.de).
-The blog is based on the [getzola/hyde](https://github.com/getzola/hyde) theme
-and rendered with [getzola/zola](https://github.com/getzola/zola).
+The blog comes with an own _layout_ and _style_ and is generated with the
+static site generator [zola](https://github.com/getzola/zola).
+
+I am by no means a web developer, so be warned about the `html` and `css` you
+find in here :^). But in general I like minimalism and `monospace`.
+
+The repository is organized as follows.
+
+- [`templates/`](templates) contains the layout
+- [`sass/`](sass) contains the style
+- [`content/`](content) contains the blog content (posts + source code examples)
+
+Once zola is installed, the website can be served for testing in the local
+network as shown below.
+```sh
+# Listen on local host (only the device running the command can visit the page).
+zola serve --open
+
+# Listen on any address and use the ip address of the device as base url. This
+# allows to visit the page during testing from other devices in the same
+# network as for example a mobile deive.
+zola serve --open -i 0.0.0.0 -u <IP_OF_DEVICE>
+```
+> NOTE: Serving with zola is only for testing, don't use zola to serve the page
+> on the web. Use a proper http server for that.