Skip to content

Commit 25bdf3a

Browse files
Revise icon contribution steps in CONTRIBUTING.md
Updated the steps for adding new icons in Icomoon, including file names and processes for importing and exporting icons. Added instructions for updating project files and committing changes.
1 parent 2005f2e commit 25bdf3a

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -181,29 +181,24 @@ Many font editing software and web-based tools exist for this purpose. Some of t
181181

182182
### Steps in Icomoon to add new Icons
183183

184-
1. Download the `icons.ttf` file from https://github.com/Acode-Foundation/Acode/tree/main/src/res/icons
185-
2. Go to https://icomoon.io/ > Start a new Project
186-
3. Import the `icons.ttf` downloaded (in step 1)
184+
1. Download the `code-editor-icon.icomoon.json` file from https://github.com/Acode-Foundation/Acode/tree/main/utils
185+
2. Go to https://icomoon.io/ > Import
186+
3. Import the `code-editor-icon.icomoon.json` downloaded (in step 1)
187187
4. All icons will be displayed after importing.
188188
5. Import the SVG icon created/downloaded to be added to the Font Family.
189-
6. On the right side, press **enable Show Characters** to view the Unicode character for that icon.
190-
7. Copy the newly added icon's Unicode character (required for later steps)
189+
6. On the right side, press **enable Show Characters** & **Show Names** to view the Unicode character & Name for that icon.
190+
7. Provided the newly added SVG icon with a name (in the name box).
191191
8. Repeat Step 5 and Step 7 until all needed new icons are added.
192192
9. Press the export icon from the top left-hand side.
193-
10. Add **Font** in the formats section, expand the **Font**, enter **code-editor-icon** as the font-family for `icons.ttf` file.
194-
11. Press the download button, and a zip file will be downloaded.
195-
196-
### Adding the Unicode characters to style.css
197-
198-
1. Open the `style.css` file present at https://github.com/Acode-Foundation/Acode/tree/main/src/res/icons
199-
2. Add a new class called `.icon.icon-name:before` e.g ```.icon.all_inclusive:before { content: "\ea18"; }```
200-
3. `content` (i.e., `ea18` -> `\ea18`) property's value is the Unicode Character copied after importing the icon in the font family.
201-
4. Save the `style.css` file.
202-
5. Extract the downloaded zip file; navigate to the `fonts` folder inside it.
203-
6. Rename `code-editor-icon.ttf` to `icons.ttf`.
204-
7. Copy & paste the renamed `icons.ttf` into https://github.com/Acode-Foundation/Acode/tree/main/src/res/icons
205-
8. Commit the changes **ON A NEW branch** (by following: [Commit Messages guide](#commit-messages))
206-
5. commit the changes **ON A NEW branch** (by following: [Commit Messages guide](#commit-messages))
193+
10. Press the download button, and a zip file will be downloaded.
194+
11. Go to the Projects section of [icomoon](https://icomoon.io/new-app), uncollapse/expand the Project named `code-editor-icon` and press the **save** button (this downloads the project file named: `code-editor-icon.icomoon.json`)
195+
196+
### Updating Project files for Icon Contribution
197+
1. Extract the downloaded zip file; navigate to the `fonts` folder inside it.
198+
2. Rename `code-editor-icon.ttf` to `icons.ttf`.
199+
3. Copy & paste the renamed `icons.ttf` into https://github.com/Acode-Foundation/Acode/tree/main/src/res/icons
200+
4. Copy and paste the `code-editor-icon.icomoon.json` file (downloaded in the adding icons steps) onto https://github.com/Acode-Foundation/Acode/tree/main/utils (yes, replace it with the newer one; we downloaded!)
201+
4. Commit the changes **ON A NEW branch** (by following: [Commit Messages guide](#commit-messages))
207202

208203
## 🔌 Plugin Development
209204

0 commit comments

Comments
 (0)