From 5d46479a3355ba6f501a9ef558fb4313c523eefb Mon Sep 17 00:00:00 2001
From: Steffen Jost <s.jost@fraport.de>
Date: Mon, 28 Oct 2024 17:48:41 +0100
Subject: [PATCH] chore(icons): add instructions on how to add icons

---
 src/Utils/Icon.hs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/Utils/Icon.hs b/src/Utils/Icon.hs
index c6a50bd81..7cf3d4bca 100644
--- a/src/Utils/Icon.hs
+++ b/src/Utils/Icon.hs
@@ -29,6 +29,13 @@ type WidgetSiteless = forall site. WidgetFor site ()
 -- We collect all used icons here for an overview.
 -- For consistency, some conditional icons are also provided, having suffix True/False
 
+{- How to add icons:
+  - edit utils/rename-fa.json by adding "our-name": "fa-name"
+  - make sure to only use fontawesome v6.6.0 free icons
+  - delete directory node_modules
+-}
+
+
 ---------------------------------------------------------------------------
 -- IMPORTANT:
 -- All icons must be manually registered within the following files: