diff --git a/.gitignore b/.gitignore index badbc02..fdd59cd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ _site .sass-cache +.jekyll-cache/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..a8aa717 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Imaginärraum Website + +This is the source for the [Imaginärraum-Website](https://imaginaerraum.de/). +We use [Jekyll](https://jekyllrb.com/) to build static HTML pages from markdown source files. +Commits to this repository will automatically trigger a rebuild of the served site. + +## Local development + +Changes can be tested locally before pushing. + +### Requirements + +* Install ruby +* `gem install jekyll bundler` +* `gem install jekyll-theme-minimal` + +### Build locally + +* `jekyll build` + +### Test locally + +* `jekyll serve` + +This opens a webserver on http://localhost:4000 and automatically rebuilds the site whenever a source file changes.