summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMateja <mail@matejamaric.com>2021-01-29 17:02:43 +0100
committerMateja <mail@matejamaric.com>2021-01-29 17:02:43 +0100
commit084af95449a3f29ad5db86ff939e0ed535445220 (patch)
tree3e6a8a5d94d572aa4ae8d3a2b8f226c055cea262
parentdfce7e8e7a7ea9120ea18f5b50643dc12aaec331 (diff)
downloadblog-084af95449a3f29ad5db86ff939e0ed535445220.tar.gz
blog-084af95449a3f29ad5db86ff939e0ed535445220.zip
Update README.
-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>.