diff --git a/README.md b/README.md index 9cb08ea1..f5582e8a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# wiki +# DS-Homebrew wiki Wikis for DS-Homebrew projects + +## Running locally +To test the site locally, install Jekyll by running: +``` +gem install bundler jekyll +``` +Then run +``` +bundle install +``` +Then you can run the site by running: +``` +bundle exec jekyll serve +``` +You may want to run with incremental building as there are a lot of pages so it takes a long time to build, note that this may cause some things to not update fully: +``` +bundle exec jekyll serve --incremental +```