Add README file

This commit is contained in:
Jesper Hess 2017-02-06 13:41:19 +01:00
parent 65972b8226
commit c8a90295cf
Signed by untrusted user: graffen
GPG key ID: 351A89E40D763F0F

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# The data.coop website
## Building the site
The site is built using [Jekyll](https://jekyllrb.com)
The simplest way to work with the site and code is to use Docker.
```git clone https://git.data.coop/data.coop/website.git data.coop
cd data.coop
docker-compose up```
This will fire up the website inside a Docker container and start listening on port 4000.
Simply connect your browser to http://localhost:4000 and you're good to go. In development
mode, the site has the [jekyll:livereload](https://github.com/RobertDeRose/jekyll-livereload) extension enabled, allowing you to see your changes immediately
upon saving files in the source directory.
## Deploying the site
TODO: Set up webhook for auto-deployment on push to master.