Skip to content

Commit

Permalink
docs: 📝 move "Adding an icon" / "Building the font" sections from rea…
Browse files Browse the repository at this point in the history
…dme.md to contributing.md
  • Loading branch information
DerZade committed Apr 15, 2024
1 parent 3529b7b commit a051144
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
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.
15 changes: 0 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,6 @@ This font is basically a subset of [Lucide Icons](https://github.com/lucide-icon

You can find a detailed breakdown of where each icon comes from in the [icon sources section](#icon-sources) at the bottom of this readme.

## Adding a 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.

## Usage

Expand Down

0 comments on commit a051144

Please sign in to comment.