README.md in govuk-jekyll-theme-0.1.1 vs README.md in govuk-jekyll-theme-0.1.2
- old
+ new
@@ -20,10 +20,19 @@
And then install the theme using:
$ bundle
+Note: to [use this theme with GitHub Pages](https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/) you will also need to add the following to the `_config.yml` file:
+
+```yaml
+remote_theme: frankieroberto/govuk-jekyll-theme
+```
+
+(This is because GitHub installs the theme directly from a GitHub repository rather than from RubyGems.)
+
+
## Usage
The theme contains all of the CSS styles and assets from [GOV.UK Elements](https://govuk-elements.herokuapp.com) and from the [GOV.UK Frontend Toolkit](https://github.com/alphagov/govuk_frontend_toolkit).
This means that there’s a basic layout, including the GOV.UK global header and footer, as well as styles for typography, buttons, form elements and icons.
@@ -31,19 +40,19 @@
## Contributing
If you’d like to propose a change to some of the underlying styles or assets, it’s best to do that 'upstream' on the original source. Confusingly, there are three separate Git repositories whose contents are combined to make this theme, so you’ll need to figure out which one contains the code you’d like to suggest a change for. These are:
* [govuk_elements](https://github.com/alphagov/govuk_elements)
-* [govuk_template(https://github.com/alphagov/govuk_template)
+* [govuk_template](https://github.com/alphagov/govuk_template)
* [govuk_frontend_toolkit](https://github.com/alphagov/govuk_frontend_toolkit)
If you have any suggestions about how the packaging-these-up-as-Jekyll-theme process could be improved, though, they would be very welcome. You can do that by adding an [issue](https://github.com/frankieroberto/govuk-jekyll-theme/issues) or submitting a [pull request](https://github.com/frankieroberto/govuk-jekyll-theme/pulls) to the GitHub repository for this theme.
## Development
To set up your environment to develop this theme, you’ll need both [npm](https://www.npmjs.com) and [Bundler](http://bundler.io).
-Then run `npm install` to install the source requirements for this theme specified in [package.json](package.json). After this the [package.sh](package.sh) script will be run to manually copy the relevant `.scss` files into the [`_sass`](_sass) folder, and the images into [`assets`](assets).
+Then run `npm install` to install the source requirements for this theme specified in [`package.json`](package.json). After this the [`package.sh`](package.sh) script will be run to manually copy the relevant `.scss` files into the [`_sass`](_sass) folder, and the images into [`assets`](assets).
The theme can then be packaged up as a Rubygem locally by running:
```bash
gem build govuk-jekyll.gemspec