-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 📝 move "Adding an icon" / "Building the font" sections from rea…
…dme.md to contributing.md
- Loading branch information
Showing
2 changed files
with
15 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## Adding an icon | ||
|
||
To add a new icon simply add the SVG in the `./svg/` subdirectory. The filename should only consist of letter, numbers and underscores. | ||
|
||
> [!IMPORTANT] | ||
> SVGs must only consist of simple shapes. Neither texts, nor outlines are allowed. Sometimes it helps to split complex shapes (especially with holes) into multiple paths. | ||
## Building the font | ||
|
||
> [!TIP] | ||
> If you do not have Node.js installed, you can also download the artifact that is automatically made available by GitHub Actions as soon as the repository is updated. (see [this guide](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts)) | ||
To build the font, `npm` and Node.js is required. Simply install all dependencies (run `npm ci`) and then run `npm run build` in the root directory of this repository. | ||
|
||
The output directory (`./out/`) includes an `example.html`-file, which can be used to check whether all icons are rendered correctly. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters