diff --git a/README.md b/README.md index b875056..adb5f2c 100755 --- a/README.md +++ b/README.md @@ -3,18 +3,32 @@ This is the main website for a pledge to stop supporting Python 2 for free in open source software. +# Preview the changes + +If you are lazy, just send a PR. The continuous integration will build a preview +on a netlify subdomain. Once the PR is submitted, look in the continuous integration +section for the `Netlify`, you may need to click 'Show all checks' section and click on `details`. + +![](prev.png) + # Run locally -Install Jekyll : `gem install jekyll`, `gem install github-pages` +Install Jekyll, we recommend installing bundler first: `gem install bundler` Clone this locally, `cd` in the newly created directory. -Run `jekyll serve -w` in one terminal, open your browser to `localhost:4000`. +In the repository run `bundle install` + +Run `bundle exec jekyll serve -w` in one terminal, open your browser to `localhost:4000`. Modify the various files, refresh your browser and enjoy. PRs welcomed. +# uninstall + +Run `bundle clean` form the root of the repository to remove packages. + # Add your project If you just want to add your project to the list of participating projects, add diff --git a/prev.png b/prev.png new file mode 100644 index 0000000..1a05bda Binary files /dev/null and b/prev.png differ