From 7a519de49405ca186de644f9b537b921710f63cc Mon Sep 17 00:00:00 2001 From: Christoffer Date: Sat, 7 Jul 2018 15:24:10 +0200 Subject: [PATCH 1/2] README: Proper formatting with newlines --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 2ad80ee..c8bf4cc 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,22 @@ ## To work on the code, either ### Use docker + You need docker-compose. Simply run `docker-compose up` to launch the site in a docker container with livereload support. ### Or install Jekyll locally #### Install Jekyll and Bundler gems through RubyGems + `gem install jekyll bundler` #### Install dependencies + `bundle install` #### Build the site local + `bundle exec jekyll serve` You can now see the site at [localhost:4000](http://localhost:4000) -- 2.43.4 From ab40a6bbaff4de4b35edea1f0d8fcd10acd1b96b Mon Sep 17 00:00:00 2001 From: Christoffer Date: Sat, 7 Jul 2018 15:24:45 +0200 Subject: [PATCH 2/2] README: Add comments about running the dev-site on Windows --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index c8bf4cc..b70ac4c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,15 @@ You need docker-compose. Simply run You can now see the site at [localhost:4000](http://localhost:4000) +### Or install Jekyll localy on Windows + +If using Ruby >=2.5 be sure to remove version numbers from dependency +Gemfile gems and remember to also delete Gemfile.lock compiling +Jekyll site. + +You will also need to recompile the gem 'eventmachine' locally. +`gem install --platform ruby eventmachine` + ## Deploy If not using Docker, it's **important** that you build the site with `JEKYLL_ENV=production bundle exec jekyll build` before deploying the contents of the `_site` directory. We're doing some debugging stuff when the project is build in the development env. -- 2.43.4