From ea4f0d05f5b63c028d74f06153aa59dca367c0b5 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 17 Sep 2019 20:36:36 -0500 Subject: [PATCH] Docs: Explain how to test locally --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b7f44347e..5174208cc 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,14 @@ and a larger image (700 px width) in each respective directory (assets/images/bo and process them in something like https://squoosh.app/ to reduce file size. If you only have one image, place it in the 'original' folder. 3. Create a pull request with the file changes. + +**To test your changes locally:** + +1. You need "ruby" and "ruby-bundler" installed locally. These instructions +were tested with ruby 2.5 and ruby-bundler 1.17.3 on a Debian Stretch system. +2. As needed, `git submodule update --init --recursive` to fetch the submodules +3. One time, run `bundle install --path vendor/bundle` +4. Run `bundle exec jekyll serve` to generate the site locally +5. Visit the displayed "server address" +6. After most local edits, the content will be updated. You will need to +reload (ctrl-r or F5) your browser