Tim/timstallard.me.uk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Tim Stallard 2016-09-03 18:23:38 +01:00
parent 6d621ee6e6
commit f673a32095
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,4 +1,14 @@
# Your [DocPad](http://docpad.org) Project
# [timstallard.me.uk](https://timstallard.me.uk)
## License
Copyright © 2016+ All rights reserved.
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