From 5c8143699f4c0c64df72d60b033de50c9fbd167a Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Wed, 6 May 2020 21:44:24 +0000 Subject: README: update --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 7acc6e6..4d70d6e 100644 --- a/README.md +++ b/README.md @@ -37,34 +37,34 @@ Set parameter values by passing them to make, i.e. Examples -------- -1. Set up an environment and run Jekyll locally: +### Jekyll in Docker - make ruby-install - make ruby-install/clean - make ruby - make chruby - make chruby/clean - make bundler - make dependencies PROJECT_DIR=../jekyll-project/ - make jekyll/serve PROJECT_DIR=../jekyll-project/ + make docker/up PROJECT_DIR=../jekyll-project/ - Some of these might not work on the first try (you'd need to install some - native dependencies for your gems, use `sudo`, etc.). +This builds two images: `jekyll_base` and `jekyll_project`, and runs a +container, which mounts PROJECT_DIR, and runs Jekyll there. -2. Run Jekyll in Docker: +To rebuild the images (i.e. when you bump dependencies), run - make docker/up PROJECT_DIR=../jekyll-project/ + make docker/build PROJECT_DIR=../jekyll-project/ - This builds two images: `jekyll_base` and `jekyll_project`, and runs a - container, which binds PROJECT_DIR, and runs Jekyll there. +Bring everything down: - To rebuild the images (i.e. when you bump dependencies), run + make docker/down - make docker/build PROJECT_DIR=../jekyll-project/ +### Jekyll on the host - Bring everything down: + make ruby-install + make ruby-install/clean + make ruby + make chruby + make chruby/clean + make bundler + make dependencies PROJECT_DIR=../jekyll-project/ + make jekyll/serve PROJECT_DIR=../jekyll-project/ - make docker/down +Some of these might not work on the first try (you'd need to install some +native dependencies for your gems, use `sudo`, etc.). License ------- -- cgit v1.2.3