commit 8ebd2280c3d576655f5ba55921cb5ca9fff63c5e
parent f02362e256fecd727607cf86bb703a288a786455
Author: Chris Bracken <chris@bracken.jp>
Date: Sun, 17 Feb 2019 16:28:22 -0800
Add README.md
Diffstat:
| A | README.md | | | 48 | ++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 48 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,48 @@
+# chris.bracken.jp
+
+If you were looking for my actual blog, you'd find it at [chris.bracken.jp][blog],
+but if you're here, odds are you're looking for the source. You've come to the
+right place.
+
+## Prerequisites
+
+To build, you'll need [hugo][hugo_install] installed on your system.
+
+## Obtaining the source
+
+First, clone the repo:
+```
+git clone git@github.com:cbracken/blog
+```
+
+Next, initialise and fetch git submodules:
+```
+git submodule update --init
+```
+
+## Building and running
+
+Fire up hugo's dev server:
+```
+# For the production site:
+hugo server
+
+# To run with draft posts enabled:
+hugo server -D
+```
+
+Follow the on-screen instructions to test the site out locally.
+
+## Adding a new post
+
+To create a new post:
+```
+hugo new post/yyyy-mm-dd-title-of-post.md
+```
+
+Edit `content/post/yyyy-mm-dd-title-of-post.md` in your favourite editor. When
+it's ready to post, remove the `draft` tag from the post header, commit the
+changes, and push.
+
+[blog]: https://chris.bracken.jp
+[hugo_install]: https://gohugo.io/getting-started/installing/
