summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9db7289..dff9e02 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
# Grimoire.ca Blog/Wiki
This repository contains the infrastructure for publishing a website, built from a suite of Markdown files and other resources, to Amazon.
+
+## Pre-requisites
+
+You will need:
+
+* [MkDocs](https://mkdocs.org) (`brew install mkdocs`)
+
+## Building
+
+To prepare this site for deployment, run mkdocs from the project's root directory:
+
+```bash
+mkdocs build
+```
+
+The resulting files will be placed in `site` under the project's root directory, replacing any files already present.
+
+You can also preview the site locally:
+
+```bash
+mkdocs serve
+```
+
+This will automatically rebuild the site every time the files in `docs` change, and will serve them on a web server at <http://127.0.0.1:8000>.