diff --git a/README.md b/README.md index d8f8faf..0358691 100755 --- a/README.md +++ b/README.md @@ -13,24 +13,33 @@ ## Installation -### As a Fork +### As a Jekyll theme + +1. Add `gem "garth-jekyll-theme"` to your `Gemfile` to add the theme as a dependancy +2. Run the command `bundle install` in the root of project to install the theme and its dependancies +3. Add `theme: garth-jekyll-theme` to your `_config.yml` file to set the site theme +4. Run `bundle exec jekyll serve` to build and serve your site +5. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options + +### As a GitHub Pages remote theme + +1. Add `gem "jekyll-remote-theme"` to your `Gemfile` to add the theme as a dependancy +2. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy +3. Add `jekyll-remote-theme` to the list of `plugins` in your `_config.yml` file +4. Add `remote_theme: daviddarnes/garth` to your `_config.yml` file to set the site theme +5. Run `bundle exec jekyll serve` to build and serve your site +6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options + +### As a Boilerplate / Fork + +_(deprecated, not recommended)_ 1. [Fork the repo](https://github.com/daviddarnes/garth#fork-destination-box) -2. Clone down the repo with `$ git clone git@github.com:username/reponame.git` -3. Delete the `demo/` folder and `screenshot.png` files -4. Change the `CNAME` record to your projects' record -5. Install bundler with `$ gem install bundler` -6. Install gems with `$ bundle install` -7. Run Jekyll with `$ bundle exec jekyll serve --watch` -8. Begin hacking for your project - -### As a Jekyll 3.3 theme gem - -1. Download the starter `/demo` content, [quick download link](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/daviddarnes/garth/tree/master/demo) -2. Install bundler with `$ gem install bundler` -3. Install gems with `$ bundle install` -4. Run Jekyll with `$ bundle exec jekyll serve --watch` -5. Begin hacking for your project +2. Replace the `Gemfile` with one stating all the gems used in your project +3. Delete the following unnecessary files/folders: `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `screenshot.png`, `CNAME` and `garth-jekyll-theme.gemspec` +4. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy +5. Run `bundle exec jekyll serve` to build and serve your site +6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options ## Site settings