From f673a32095ebc7908b6c0c1afc8232b9bcfbc6b6 Mon Sep 17 00:00:00 2001 From: Tim Stallard Date: Sat, 3 Sep 2016 18:23:38 +0100 Subject: [PATCH] Updated readme --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 673c3c2..4de4ec7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -# Your [DocPad](http://docpad.org) Project +# [timstallard.me.uk](https://timstallard.me.uk) -## License -Copyright © 2016+ All rights reserved. \ No newline at end of file +This is the code behind timstallard.me.uk, which is built using Docpad. + +To run: +1. You'll need Node and npm to be installed +2. Install dependencies, by running `npm i` +3. Automagically compile the site and run a web server using `docpad run` + (note: you'll need to use `docpad.cmd` on Windows, due to an bug, since a plain js docpad config file is being used, rather than coffeescript) + +To compile the site for deployment: +1. Run `docpad generate` + +© Tim Stallard 2016