From a05114498fc634e801d6de87db36a7f0d4a3a982 Mon Sep 17 00:00:00 2001 From: DerZade Date: Mon, 15 Apr 2024 16:28:58 +0200 Subject: [PATCH] docs: :memo: move "Adding an icon" / "Building the font" sections from readme.md to contributing.md --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 15 --------------- 2 files changed, 15 insertions(+), 15 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..614de36 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 9dfad1f..cdae4d6 100644 --- a/README.md +++ b/README.md @@ -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