diff --git a/.gitignore b/.gitignore index abba15c..eea6179 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /target -/build \ No newline at end of file +/build +/.idea \ No newline at end of file diff --git a/README.md b/README.md index 40e65bb..db6b026 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,40 @@ # ApfelNetzwerk -[Considerations](docs/considerations.md) \ -[Setup](docs/SETUP.md) \ No newline at end of file +1. [ApfelNetzwerk](#apfelnetzwerk) \ + 1.1. [Use Case Diagram](#use-case-diagram) + 1.2. [DIY Problem Definition](#diy-problem-definition) +2. [Additional infos about the project](#additional-infos-about-the-project) \ + 2.1. [Considerations](#approachesconsiderations)\ + 2.2. [Setup](#setup) + + + +# Apfelnetzwerk + +## Use Case Diagram +Notes: The use case diagram is generated by graphiv which can be seen under docs, +we used a python libary to interact with graphivs that then convert the code into the DOT language used by graphiv \ +![Use Case Diagram](docs/use_case_diagram.svg) + +## DIY Problem Definition +![DIY Problem Definition](docs/diy-problem-definition.jpg) + +## Empathy Map +![Empathy Map](docs/empathy-map.jpg) + +## Walt Disney +![Walt Disney](docs/walt-disney.jpg) + + +## TODO +![TODO](docs/HACKERSOHN%20-%20Frame%204.jpg) + + + +# Additional infos about the project + +## Approaches/Considerations +In the following [document](docs/considerations.md) you can find various approaches/problems/learning we had as a group + +## Setup +We set up a dedicated [document](docs/SETUP.md) on how to setup a project mainly involving docker \ No newline at end of file diff --git a/docs/HACKERSOHN - Frame 4.jpg b/docs/HACKERSOHN - Frame 4.jpg new file mode 100644 index 0000000..b4e6d55 Binary files /dev/null and b/docs/HACKERSOHN - Frame 4.jpg differ diff --git a/docs/diy-problem-definition.jpg b/docs/diy-problem-definition.jpg new file mode 100644 index 0000000..8bebfd5 Binary files /dev/null and b/docs/diy-problem-definition.jpg differ diff --git a/docs/empathy-map.jpg b/docs/empathy-map.jpg new file mode 100644 index 0000000..6ea27c7 Binary files /dev/null and b/docs/empathy-map.jpg differ diff --git a/docs/walt-disney.jpg b/docs/walt-disney.jpg new file mode 100644 index 0000000..a6befe4 Binary files /dev/null and b/docs/walt-disney.jpg differ