summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMateja <mail@matejamaric.com>2021-03-26 13:50:17 +0100
committerMateja <mail@matejamaric.com>2021-03-26 13:50:17 +0100
commitc2315bccc5f3f25e378d549cd17da93c6b6c8a96 (patch)
tree5f3654d4850bbb295d3d4199e562385543adc1ba /README.md
parent3b0f0e86b8f012ed71bd3f652369b9d5d8a352b0 (diff)
parent47f5fbe92a7a5cc8f9906927e73527d278d2b542 (diff)
downloadblog-c2315bccc5f3f25e378d549cd17da93c6b6c8a96.tar.gz
blog-c2315bccc5f3f25e378d549cd17da93c6b6c8a96.zip
Merge branch 'main' of github.com:MatejaMaric/blog into main
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 167c48a..4e5558d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
-# Work in progress
+# About this project
-I am moving my blog from plain HTML and CSS to Hugo.
+This code is used to build [my website](https://matejamaric.com) using [Hugo](https://gohugo.io/).
+
+It doesn't use any prebuilt theme. Source Markdown files are in `content` directory.
+The way site is build is described in `layouts` directory.
+General structure and navbar of every page is described in `layouts/_default/baseof.html` template.
+Structure of blog posts is described in `layouts/blog/single.html`.
+
+# How to build
+
+Install [Hugo](https://gohugo.io/) and just run `hugo` command which will generate `public` directory
+that contains the files you can host pretty much anywhere.
+
+You can also run `hugo server` which will start development web server on <http://localhost:1313>.