diff --git a/about.md b/about.md index 2f4d980..0e10b30 100644 --- a/about.md +++ b/about.md @@ -2,4 +2,28 @@ title: About Garth --- -Garth is a really simple Jekyll theme, like really simple. Ya get me? +A stupidly simple theme for Jekyll, using the official Jekyll theme implementation. +- [Fork on GitHub](https://github.com/daviddarnes/garth) +- [Install Garth](https://github.com/daviddarnes/garth#installation) +- [Tip me $5](https://www.paypal.me/daviddarnes/5usd) + +## Installation + +### As a Fork + +1. [Fork the repo](https://github.com/daviddarnes/garth-jekyll-theme#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-jekyll-theme/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 diff --git a/demo/about.md b/demo/about.md index 2f4d980..0e10b30 100644 --- a/demo/about.md +++ b/demo/about.md @@ -2,4 +2,28 @@ title: About Garth --- -Garth is a really simple Jekyll theme, like really simple. Ya get me? +A stupidly simple theme for Jekyll, using the official Jekyll theme implementation. +- [Fork on GitHub](https://github.com/daviddarnes/garth) +- [Install Garth](https://github.com/daviddarnes/garth#installation) +- [Tip me $5](https://www.paypal.me/daviddarnes/5usd) + +## Installation + +### As a Fork + +1. [Fork the repo](https://github.com/daviddarnes/garth-jekyll-theme#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-jekyll-theme/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