README.md in jekyll-theme-open-project-1.0.6 vs README.md in jekyll-theme-open-project-1.0.7
- old
+ new
@@ -626,18 +626,47 @@
will be included. If you modify theme to add more directories that
need to be included in the gem, edit regexp in the gemspec.
### Building and releasing
-To check your theme, run:
+#### Manual test during development
- ./develop/build
+While working on a site using this Jekyll theme, you can use local theme copy,
+and thus test the theme before release. The sequence would be as follows:
-It’ll build Jekyll site and run some checks, like HTML markup validation.
+1. Change Gemfile to point to local theme copy.
-To build new gem and push it to rubygems.org, run:
+ For example, change from `gem "jekyll-theme-open-project", "~> 1.0.6"`
+ to `gem "jekyll-theme-open-project", :path => "../jekyll-theme-open-project"`
+2. Run `bundle exec jekyll serve`.
+
+3. Make changes to theme and reload site (it may not reload automatically).
+
+4. Release theme — see below.
+
+5. (To bump the site to this latest version, change Gemfile back,
+ bump theme dependency version to the one just released,
+ run `bundle --full-index` to update lockfile properly,
+ and your site is ready to go.)
+
+#### Releasing
+
+Update .gemspec file with the new version and commit the change.
+
+Build new gem version and push it to rubygems.org with:
+
./develop/release
+
+#### Testing with build script (TBD)
+
+May not work at the moment — see #26. Please use the other test option.
+
+To check your theme, run:
+
+ ./develop/build
+
+It’ll build Jekyll site and run some checks, like HTML markup validation.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).