diff --git a/README.md b/README.md index 2ad80ee..b70ac4c 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,35 @@ ## 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) +### 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.