Skip to content

Commit

Permalink
updated contributing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
PKief committed Oct 22, 2017
1 parent c590b01 commit 03a9f45
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
- [Create issues](#create-issues)
- [Add new icons](#add-new-icons)
- [Icon color](#icon-color)
- [Check icon](#check-icon)
- [Free software to create/edit SVG icons](#free-software-to-createedit-svg-icons)
- [Use icons from here](#use-icons-from-here)
- [Add translations](#add-translations)
Expand All @@ -15,20 +14,20 @@

## Create issues
You need an icon for a specific file ending? No problem, just follow these guidelines:
- [create an issue](https://github.com/PKief/vscode-material-icon-theme/issues/new)
- describe the file ending (e.g. '.xml') and the language (e.g. XML)
- show an example image of the icon or link to official website

## Add new icons
1. Create icon as SVG
2. Copy icon to `icons`-folder
3. Edit `src/material-icons.json`
3. Edit the icon configuration files under `src/icons` folder:
- fileIcons.ts
- folderIcons.ts
- languageIcons.ts

### Icon color
Choose your icon colors from the [material design colors](https://material.google.com/style/color.html#color-color-palette).

### Check icon
Please check the created icon with your VSCode. Copy your source files of the theme into your extension folder (e.g. `/Users/\<username>/.vscode/extensions/PKief.material-icon-theme-x.x.x`). Restart your VSCode and create some example files.

### Free software to create/edit SVG icons
- [Inkscape](https://inkscape.org/en/)

Expand Down

0 comments on commit 03a9f45

Please sign in to comment.