diff --git a/README.md b/README.md new file mode 100644 index 0000000..12a0bbf --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Kosmos.org Website + +This website (or rather foundation for a future website) is based on +[DocPad](https://docpad.org). + +## Prerequisites + +You will need the following things properly installed on your computer. + +* [Git](http://git-scm.com/) +* [Node.js](http://nodejs.org/) (with NPM) + +## Setup/installation + +* `git clone ` this repository +* change into the new directory +* `npm install` +* Make sure `./node_modules/.bin` is in your $PATH (before system-wide npm modules) + +## Running / Development + +* `docpad run` +* Visit the website at [http://localhost:9778](http://localhost:9778). + +## Build + +* `./build` + +## Build & deploy + +With the correct (5apps) remote added: + +* `./deploy`