From 1b337739a69c6da2f421955b7e61996e3ecc9b2d Mon Sep 17 00:00:00 2001 From: Atlas48 Date: Sat, 19 Jun 2021 15:01:36 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/README.md b/README.md index 486527d..b4b283c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -# [Garth](https://garth.darn.es/) -[![Gem Version](https://badge.fury.io/rb/garth-jekyll-theme.svg)](https://badge.fury.io/rb/garth-jekyll-theme) +# [Funky](https://garth.darn.es/) 🥁 A really basic theme for Jekyll, using the official Jekyll theme implementation. @@ -43,17 +42,6 @@ To give you a running start I've put together some starter kits that you can dow 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. 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 - ## Customising When using Garth as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.