From b885384901a9bcd6d5ca26dda1bcfa6706c62c05 Mon Sep 17 00:00:00 2001
From: "Heider, Martin" <heider@tugraz.at>
Date: Tue, 21 May 2024 14:08:43 +0200
Subject: [PATCH] added readme.md

---
 README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..35d139e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+
+# SVG on the web
+
+In this project we show typical use-cases of SVGs on the web and 
+a basic project structure. 
+
+We also include a tool for stripping unnecessary style elements 
+in order to manipulate them via code on the final page.
+
+## 1 SVG use cases
+
+On the sample web page we show SVGs the following use-cases:
+- Changing the color of icons.
+- Scaling icons to create the illusion of flipping a switch. 
+- Changing the font of text inside an SVG 
+- Hover effects to show enabled and disabled icons.
+
+Most these changes are attached to the CSS of the web 
+page and can be manipulated by the JS code as well.
+
+
+
+## 2 SVG to inline Typescript
+
+We provide a tool to strip SVGs from formatting and 
+add them to an icon-definitions.ts file.
+
+Usage:
+```
+npm install
+npx gulp
+```
+
+## 3 Team
+
+Some of the code was reused from [Rslidy](https://github.com/tugraz-isds/rslidy)
+
+The following people have contributed to Rslidy:
+
+- Keith Andrews
+  [kandrews@iicm.edu](mailto:kandrews@iicm.edu?subject=Rslidy)  
+  Project Leader
+
+- Patrick Hipp  
+  Master's Thesis, main developer
+
+- Christopher Kopel
+
+- Gsellmann Inge, Heider Martin, Leitner Lukas, Patel Vrutanjali Rakesh  
+  IAweb WS 2023 G1
+
+- Angelika Droisner, Ana Korotaj  
+  IAweb WS 2018 G1a
+
+- Thomas Eibl, Michael Glatzhofer, Christoph Heidenreich, Verena Schiffer  
+  IAweb WS 2017 G1
+
+- Rok Kogovšek, Alexei Kruglov, Fernando Pulido Ruiz, Helmut Zöhrer  
+  IAweb WS 2016 G5
+
+- Markus Schofnegger  
+  BSc 02 Nov 2015
+
+- Filippo Garolla, Sabine Lukas, Matthias Schlesinger, Karin Wilding  
+  IAweb WS 2014 G1
+
+- Elias Zeitfogel, Patrick Kasper, Karina Priebernig, Clemens Meinhart  
+  IAweb WS 2013 G4
+
+
+The following people have contributed to this project:
+
+- Martin Heider  
+  IVIS SS24 G1
\ No newline at end of file
-- 
GitLab