Skip to content

Commit

Permalink
docs: 📝 document sources of icons
Browse files Browse the repository at this point in the history
  • Loading branch information
DerZade committed Feb 6, 2024
1 parent 9179540 commit c538668
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Arma Events Icon font
This repository contains the icon font for [arma.events](https://arma.events) using [font ligatures](https://fonts.google.com/knowledge/glossary/ligature).

This font is basically a subset of [Lucide Icons](https://github.com/lucide-icons/lucide) together with some icons that were created specifically for [arma.events](https://arma.events). All icons originating from Lucide have the same name as in Lucide, but `-` (minus) has been changed to `_` (underscore).
This font is basically a subset of [Lucide Icons](https://github.com/lucide-icons/lucide) together with some icons that were created specifically for [arma.events](https://arma.events). All icons originating from Lucide have the same name as in Lucide, but `-` (minus) has been changed to `_` (underscore).

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

Expand All @@ -22,3 +24,25 @@ The output directory (`./out/`) includes an `example.html`-file, which can be us
## Usage

To use the font, simply include the `arma-eventicons.css` from the output directory. You may have to adjust the paths to the font files.

## Icon Sources

Most icons are from [Lucide Icons](https://github.com/lucide-icons/lucide), but there are a few exceptions:

The following icons are from [Simple Icons](https://github.com/simple-icons/simple-icons):
- `discord`
- `twitter`
- `youtube`

The following icons are custom made for arma.events:
- `condensed`
- `crown`
- `crown_off`
- `edit_2`
- `expanded`
- `grip`
- `reorder`
- `text`



0 comments on commit c538668

Please sign in to comment.