|
| 1 | +# Information about icons in this directoy |
| 2 | + |
| 3 | +## License |
| 4 | + |
| 5 | +All icons in this directory are provided by |
| 6 | +[Font Awesome Free](https://fontawesome.com), version 6.7.2. |
| 7 | + |
| 8 | +- The icons are licensed under the [Creative Commons Attribution 4.0 |
| 9 | + International (CC-BY-4.0)](https://creativecommons.org/licenses/by/4.0/) |
| 10 | + license. |
| 11 | +- This license allows you to use, modify, and distribute the icons, provided |
| 12 | + proper attribution is given. |
| 13 | + |
| 14 | +## Usage |
| 15 | + |
| 16 | +- You may use, modify, and distribute the icons in this repository in |
| 17 | + compliance with the [Creative Commons Attribution 4.0 International |
| 18 | + (CC-BY-4.0)](https://creativecommons.org/licenses/by/4.0/) license. |
| 19 | + |
| 20 | +## Modifications |
| 21 | + |
| 22 | +- These icons have been resized, recolored, or otherwise modified to fit the |
| 23 | + requirements of this project. |
| 24 | + |
| 25 | +- These modifications alter the appearance of the original icons but remain |
| 26 | + covered under the terms of the |
| 27 | + [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license. |
| 28 | + |
| 29 | +## Contributing SVG Icons |
| 30 | + |
| 31 | +To ensure visual consistency, traceability, and proper license attribution, |
| 32 | +follow these guidelines when adding or modifying icons. |
| 33 | + |
| 34 | +## ⚠️ Important: Changing Font Awesome Version |
| 35 | + |
| 36 | +If you update to a different Font Awesome version, you must **update all SVG |
| 37 | +files** and **comments inside the files** to reflect the new version number and |
| 38 | +licensing URL accordingly. For example: |
| 39 | + |
| 40 | +* Original: |
| 41 | +```xml |
| 42 | +<!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--> |
| 43 | +``` |
| 44 | +* Updated: |
| 45 | +```xml |
| 46 | +<!--!Font Awesome Free X.Y.Z by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright YYYY Fonticons, Inc.--> |
| 47 | +``` |
| 48 | + |
| 49 | +## Adding a new icon |
| 50 | + |
| 51 | +1. Use only [Font Awesome Free Icons](https://fontawesome.com/icons). |
| 52 | +2. Save the icon as a .svg file in this directory. |
| 53 | +3. Include the following attribution comment at the top of the file (do not change it): |
| 54 | +```xml |
| 55 | +<!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--> |
| 56 | +``` |
| 57 | +4. Right before the `<path>` element, add the following metadata comment, using the correct values: |
| 58 | +```xml |
| 59 | +<!-- |
| 60 | + Icon Name: [icon-name] |
| 61 | + Icon Family: [classic | sharp | brands | etc.] |
| 62 | + Icon Style: [solid | regular | light | thin | duotone | etc.] |
| 63 | +--> |
| 64 | +``` |
| 65 | + |
| 66 | +### Example SVG Structure |
| 67 | + |
| 68 | +```xml |
| 69 | +<svg width="13" height="13" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"> |
| 70 | + <!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--> |
| 71 | + <!-- |
| 72 | + Icon Name: plus |
| 73 | + Icon Family: classic |
| 74 | + Icon Style: solid |
| 75 | + --> |
| 76 | + <path fill="#5fa225" stroke="#5fa225" stroke-width="30" d="M256 80c0-17.7-14.3-32-32-32s-32 14.3-32 32l0 144L48 224c-17.7 0-32 14.3-32 32s14.3 32 32 32l144 0 0 144c0 17.7 14.3 32 32 32s32-14.3 32-32l0-144 144 0c17.7 0 32-14.3 32-32s-14.3-32-32-32l-144 0 0-144z"/> |
| 77 | +</svg> |
| 78 | +``` |
0 commit comments