Add README

This commit is contained in:
Basti 2015-06-06 14:45:40 +02:00
parent 211172d091
commit 4e38387f92
1 changed files with 33 additions and 0 deletions

33
README.md Normal file
View File

@ -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 <repository-url>` 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`