You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
22
22
<ol>
23
23
<li>"Icon" refers to the set of svgs/icons of a technology/tool. Ex: We might refer to the React svgs and React icons as the React Icon</li>
24
24
<li>"SVG/<code>.svg</code>" refers to the <code>svg</code> versions of the Icons.</li>
25
-
<li>"icons" refers to the icon versions of the Icons.</li>
25
+
<li>"icons" (lowercase) refers to the font icon versions of the Icons.</li>
26
26
</ol>
27
27
28
28
<hr>
@@ -69,7 +69,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
69
69
The <b>original</b> version are only available in svg format, so they do not need to be as simple and can contain numerous colors.
70
70
</li>
71
71
<li>
72
-
Some icons are really simple (like the Apple one), so the original version can be used as the plain version and as the icon font. In this case, you'll only need to make only one of the version (either "original" or "plain"). You can then add an alias in the <code>devicon.json</code> so they can be found with either the "original" or "plain" naming convention. Note: this only applies to font icon versions only, not the SVG versions.
72
+
Some icons are really simple (ex. Apple), so the original version can be used as the plain version and as the icon font. In this case, you'll only need to make one of the version (either "original" or "plain"). You can then add an alias in the <code>devicon.json</code> so they can be found with either the "original" or "plain" naming convention. Note: this only applies to font icon versions only, not the SVG versions.
73
73
74
74
</li>
75
75
</ul>
@@ -91,15 +91,16 @@ First of all, thanks for taking the time to contribute! This project can only gr
<li>Each Icon has its own folder located in the <code>icons</code> folder</li>
95
-
<li>Each Icon folder must contain one <code>.eps</code> file and as many <code>.svg</code> files as versions available (at the minimum one <code>.svg</code> file)</li>
96
-
<li>The <code>.eps</code> file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard</li>
94
+
<li>Each icon has its own folder located in the <code>icons</code> folder</li>
95
+
<li>Each folder <i>may</i> contain one <code>.eps</code> file</li> (optional)
96
+
<li>The <code>.eps</code> file should contains all available versions of an icon. Each version is contained in a 128px by 128px artboard</li>
97
+
<li>Each folder must contain all the <code>.svg</code> files for the Icon</li>
97
98
</ul>
98
99
99
100
<hr>
100
101
<h2id='updateDevicon'> Updating the <code>devicon.json</code> </h2>
101
102
<p>
102
-
Before you open a PR into Devicon, you'd have to update the <code>devicon.json</code>. This is essential for our build script to work and to document your work.
103
+
Before you open a PR into Devicon, you must update the <code>devicon.json</code>. This is essential for our build script to work and to document your work.
103
104
</p>
104
105
<p>
105
106
Here is the object that each of your Icon must have:
@@ -214,7 +215,7 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
214
215
{
215
216
"base": "original", // here is the base version that we will upload to Icomoon
216
217
"alias": "plain" // this is its alias. Our script will create a reference so users can search using "original" or "plain" for this icon
217
-
// note that you don't provide aliases for the svg version. If "original" is not a font version (i.e can't be made into a font), there's no need to provide it with a plain alias
218
+
// note that you don't provide aliases for the svg version. If "original" can't be made into a font, there's no need to provide it with a plain alias
0 commit comments