Doku

Danielle-Schuman · Feb 1, 2021 · 2f3b800 · 2f3b800
1 parent 67a0d77
commit 2f3b800
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 41 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/Projektplanung/Für 4. Präsi/InfoVis Gruppe 4 Gantt weniger Text copy.png b/Projektplanung/Für 4. Präsi/InfoVis Gruppe 4 Gantt weniger Text copy.png
diff --git a/Projektplanung/Für 4. Präsi/InfoVis Gruppe 4 Gantt weniger Text.pdf b/Projektplanung/Für 4. Präsi/InfoVis Gruppe 4 Gantt weniger Text.pdf
diff --git a/Projektplanung/Für 4. Präsi/InfoVis Gruppe 4 Gantt weniger Text.png b/Projektplanung/Für 4. Präsi/InfoVis Gruppe 4 Gantt weniger Text.png
diff --git a/Projektplanung/Für 4. Präsi/Zukunft.png b/Projektplanung/Für 4. Präsi/Zukunft.png
diff --git a/Projektplanung/Für 4. Präsi/dieser MS.png b/Projektplanung/Für 4. Präsi/dieser MS.png
diff --git a/Projektplanung/Für 4. Präsi/letzter MS.png b/Projektplanung/Für 4. Präsi/letzter MS.png
diff --git a/Projektplanung/InfoVis Gruppe 4 Gantt (Updated MS3).pdf b/Projektplanung/InfoVis Gruppe 4 Gantt (Updated MS3).pdf
diff --git a/Projektplanung/InfoVis Gruppe 4 Gantt (final).pdf b/Projektplanung/InfoVis Gruppe 4 Gantt (final).pdf
diff --git a/Projektplanung/InfoVis Gruppe 4 Gantt (first version).pdf b/Projektplanung/InfoVis Gruppe 4 Gantt (first version).pdf
diff --git a/Projektplanung/InfoVis Gruppe 4 Gantt für Präsi.jpg b/Projektplanung/InfoVis Gruppe 4 Gantt für Präsi.jpg
diff --git a/Projektplanung/InfoVis Gruppe 4 Planung Spreadsheet.pdf b/Projektplanung/InfoVis Gruppe 4 Planung Spreadsheet.pdf
diff --git a/Projektplanung/InfoVis_Doku.pdf b/Projektplanung/InfoVis_Doku.pdf
diff --git a/README.md b/README.md
@@ -1,11 +1,21 @@
-# InfoVis-Group4
-## Start the Application
-Before starting the application, you need to install the following npm package:
+# InfoVis-Group4 - Project „Hamsterkäufe unter der Lupe“
+## Open the Application
+To access the application, open https://danielle-schuman.github.io/InfoVis-Hamsterkaeufe-unter-der-Lupe/ in Firefox or Chrome.
+Be aware that on small screens, you might need to zoom out a couple of times, by entering STRG+- and then reloading the page, to get an optimal page layout.
+
+## Browser compatibility
+Our application supports Chrome (Version 88.0.4324.96 and newer) and Firefox (Version 85.0 and newer).
+It also runs reasonably well on Safari (Version 14.0.2 and newer).
+We do not support Microsoft Edge, Internet Explorer, Opera, older Versions of Firefox, mobile browsers or any other browsers not mentioned in this section.
+
+## Start the Application locally
+Alternatively, you can run the application on your local computer after downloading the source code from this repository.
+Before starting it, you need to install the following npm package:
 ```batch
 npm install --global http-server
 ```
 
-or run this function using npx without installing it first:
+or you can run this function using npx without installing it first:
 ```batch
 npx http-server
 ```
@@ -20,57 +30,33 @@ The application will then be available here:
 http://localhost:8080
 ```
 
-## Available online
-at https://danielle-schuman.github.io/InfoVis-Hamsterkaeufe-unter-der-Lupe/
-
-## Browser compatibility
-Our application supports Chrome (Version 88.0.4324.96 and newer), Firefox (Version 85.0 and newer) and Safari (Version 14.0.2 and newer), but looks best in Chrome.
-We do not support Microsoft Edge, Internet Explorer, Opera, older Versions of Firefox and mobile browsers.
-
-# Glossar
-## Previously Planned Features 4 Our Application
+# Glossary
+## Features of our Application
 - [x] Base Structure of the Project
 - [x] Connected Scatterplot
-  - [x] First prototype
   - [x] Shows progress for each bubble
   - [x] Shows flag on each bubble representing the countries
   - [x] Can hide/show progress lines for all countries when triggered by a toggle
-  - [x] Contains real data
+  - [x] Contains real data, interpolated values are marked by color
+  - [x] Has Zoom-Functionality which can be triggered by a button
+  - [x] Has tooltip showing numbers on hover
 - [x] Spider Chart
-  - [x] First prototype
   - [x] Shows progress for each country
   - [x] Can hide/show data for specific countries triggered by filter checkboxes
   - [x] Contains real data
+  - [x] Is only shown when the checkbox of at least one country is checked
+  - [x] Can show data of several countries at once
+  - [ ] ~~Shows incidence as a number next to the chart~~
+  - [ ] ~~Shows incidence as color brightness~~
 - [x] Slider
-  - [x] First implementation (not fully integrated in the application)
   - [x] Integrated implementation
   - [x] Manipulates the scatter chart
   - [x] Manipulates the spider chart
-- [x] Filter ~~Toggle~~ Undo-Button
-  - [x] Is turned on automatically when a checkbox is checked or turned off when the last checkbox is unchecked
-
-## Optional Features
-- [x] Slider
   - [x] Supports a playback function which can be triggered by a play-button
 - [x] Filter ~~Toggle~~ Undo-Button
   - [x] Turns ~~on/~~ off the effect of all filter checkboxes
-- [x] Connected Scatterplot
-  - [x] Flaggen in Länder-Bubbles
-  - [x] Toggle für Verlauf ein- & ausblenden bei Länder Plot
-- [x] Spider Chart
-  - [x] ein- & ausblendbar 
-  - [ ] ~~cool animierter Übergang von Liniendiagramm zu Spider Plot~~
-  - [x] Spider Plot von verschiedenen Länder übereinander
-  - [ ] ~~Inzidenz anzeigen als Zahl beim Spider Plot~~
-  - [ ] ~~Inzidenz als Farbhelligkeit in Spider Plot~~
-- [ ] Other Features
-  - [x] Undo-Button für Filter
-  - [ ] ~~Undo-Button~~
-  - [ ] ~~Speicher-Button~~
-  - [x] Zoom-Functionality for Scatterplot
-
-
-
+  - [x] Is turned on automatically when a checkbox is checked or turned off when the last checkbox is unchecked
+- [x] Legend showing which color represents which country
 
-## Weiterführende Informationen
-- Notizen zu den bisherigen Besprechungen / Meilensteinen: see private Repo
+## Further Information
+A Dokumentation of how we planned and executed our project can be found in the folder "Projektplanung", inside a PDF-file called "InfoVis_Doku.pdf".