Mibew/simple-icons
1
0
Fork 0
mirror of https://github.com/Mibew/simple-icons.git synced 2025-01-17 23:51:08 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add building instructions to CONTRIBUTING.md

Browse Source
This commit is contained in:
Eric Cornelissen 2017-08-17 13:24:59 +02:00
parent 7453b07f3c
commit 138cca3e6c
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -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:
</svg>
```
* * *
# 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/`