From a1157bf46e6b1a25d0cfa709b5069ac8f04692d2 Mon Sep 17 00:00:00 2001 From: Raymond Wanyoike Date: Thu, 5 Jan 2017 18:20:26 +0300 Subject: [PATCH] Add setup instructions --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f4619a..4d1b539 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # pelican-alchemy -Demo! +pelican-alchemy demo website! + +## Fork / Clone the repo + +If you haven't already, clone this repo (or your version of it), and: + + $ git submodule init + $ git submodule update + +## Install Pelican & friends + +Use `pip` to install the list of dependencies (including Pelican) into your virtual environment: + + $ pip install -r requirements.txt + +## Generate the website + +Now that the dependencies exists, we can build: + + $ make html + +This takes the Markdown files from the `content/` directory and generates static HTML pages inside the `output/` directory. + +## Preview the website + +You can serve the generated site so it can be previewed in your browser: + + $ make serve