From 138cca3e6c00c6ca03777b2efbca713de21a7ba6 Mon Sep 17 00:00:00 2001 From: Eric Cornelissen Date: Thu, 17 Aug 2017 13:24:59 +0200 Subject: [PATCH 1/2] Add building instructions to CONTRIBUTING.md --- CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2030f178..cd7e7f39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ This repository welcomes contributions and corrections. Before submitting a pull ## JSON data for simpleicons.org In addition to following the guidelines for SVGs, list new icons in the `_data/simple-icons.json` file. Each icon in the array has three required values: - + - The `title` of the new SVG. - A `hex` color value that matches the brand or logo's main accent color. (Without the `#` pound symbol.) - The `source` URL of the logo being used. @@ -50,3 +50,12 @@ Here is the un-minified contents of the GitHub icon, for reference: ``` +* * * + +# Building locally + +Make sure you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Jekyll](https://jekyllrb.com/) installed (using `$ gem install jekyll bundler`). Then follow these steps: +- Initialize this repository as a new Jekyll project using `$ jekyll new . --force` from the root of the repo. +- Remove the newly generated `index.md` file. +- Build and run the website locally using `$ bundle exec jekyll serve`. +- Connect to the website in your browser via the "Server address" provided by the output of this command, e.g. `http://localhost:4000/` From 5971f9354834941383f539280a38ea9bda6ff00b Mon Sep 17 00:00:00 2001 From: Eric Cornelissen Date: Thu, 17 Aug 2017 15:01:30 +0200 Subject: [PATCH 2/2] Use `jekyll serve` in build instructions --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd7e7f39..ed737ebd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,8 +54,7 @@ Here is the un-minified contents of the GitHub icon, for reference: # Building locally -Make sure you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Jekyll](https://jekyllrb.com/) installed (using `$ gem install jekyll bundler`). Then follow these steps: -- Initialize this repository as a new Jekyll project using `$ jekyll new . --force` from the root of the repo. -- Remove the newly generated `index.md` file. -- Build and run the website locally using `$ bundle exec jekyll serve`. +- Make sure you have [Ruby](https://www.ruby-lang.org/en/downloads/) installed. +- Make sure you have [Jekyll](https://jekyllrb.com/) installed (using `$ gem install jekyll bundler`). +- Build and run the website locally using `$ jekyll serve`. - Connect to the website in your browser via the "Server address" provided by the output of this command, e.g. `http://localhost:4000/`