README.md in alembic-jekyll-theme-0.1.2 vs README.md in alembic-jekyll-theme-0.1.3
- old
+ new
@@ -37,32 +37,31 @@
- Designed with [Siteleaf](http://www.siteleaf.com/) in mind
- Has documentation
## Installation
-### As a boilerplate kit
+### As a Boilerplate / Fork
-1. Fork the repo
+1. [Fork the repo](https://github.com/daviddarnes/alembic#fork-destination-box)
2. Clone down the repo with `$ git clone git@github.com:username/reponame.git`
-3. Delete the `demo/` folder, `alembic-jekyll-theme.gemspec` and `screenshot.png` files
-4. Open the `/_config.yml` file and change details to your own project details
-5. Change the `CNAME` record to your projects' record
-6. Install GitHub Pages locally with `$ gem install github-pages`
-7. Run Jekyll from inside the the root of the repo using `$ jekyll serve --watch`
+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. Install the gem with `$ gem install alembic-jekyll-theme`
-2. Download the starter `/demo` content, [quick download link](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/daviddarnes/alembic/tree/master/demo)
-3. Customise demo content to your project content
-4. Open the `/_config.yml` file and change details to your own project details
-5. Run Jekyll from inside the the root of the repo using `$ jekyll serve --watch`
-6. Begin hacking for your project
+1. Download the starter `/demo` content, [quick download link](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/daviddarnes/alembic/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
### Boilerplate & Theme differences
-The boilerplate kit is better for more drastic hacking and changes, a project that's quite different to any other and needs a lot of custom work done. Additionally, you'll only be able to use this method if you want to host it on GitHub Pages, as themes can't be submitted so [this one hasn't been approved](https://pages.github.com/themes/)... yet.
+The boilerplate kit is better for more drastic hacking and changes, a project that's quite different to any other and needs a lot of custom work done. Additionally you'll only be able to use this method if you want to host it on GitHub Pages, as [themes can't be submitted](https://pages.github.com/themes/)... yet.
Using the theme will allow you to receive updates made and will be more programmatic. To make your own changes you'll need to overwrite the files with your own. For example: If I want to change the colours of my site I'll need to copy the [`_colors.scss`](https://github.com/daviddarnes/alembic/blob/master/_sass/_colors.scss) file and create my own in `_sass/colors.scss` with my own changes. This is the same for all files within the theme, which means your own project will be more lean than if you were to use the boilerplate.
## Configuration