From f90aa9ef9d897c80fb71e9e9b9c5ffd387e6cc07 Mon Sep 17 00:00:00 2001 From: codedust Date: Tue, 13 Jul 2021 19:21:39 +0200 Subject: [PATCH] Add build instructions --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d885133..157fa50 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,24 @@ Gefördert durch die Jugend- und Familienstiftung des Landes Berlin im Rahmen de [Hier](https://jugendhackt.github.io/Handbuch-Jugend-Hackathons) geht es zur Webseite des Handbuchs. - +## How to build +First, install the dependencies from the `Gemfile`: +```bash +bundle config set --local path 'vendor/bundle' +bundle install +``` + +Now, you can build the static website: +``` +bundle exec jekyll +``` + +The static website will be written to the `_site` directory. + +Jekyll can also serve the website on localhost and auto-regenerate the website when files change: +``` +bundle exec jekyll serve +``` ## How to add translations