Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
isabellwaas authored Aug 29, 2021
1 parent 63817f0 commit cd4896a
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
![Linux](https://img.shields.io/badge/Linux-untested-blue)

## Introduction
**HofUniversityManager** is an application to manage everyday student life. It is specially made for the various services such as mensa or timetables of Hof University. However, the application can be used freely as a basis for student administration programs of other universities.
**HofUniversityManager** is an application to manage everyday student life. It is specially made for the various services such as mensa or timetables of Hof University.

The application was developed as part of the Software Engineering 2 module in a group work in the third semester of our studies. It is written in Java 15 with the JavaFX framework in version 11. It runs on Windows and on macOS and it should run on Linux but we couldn't test it. Due to being the first larger programming project of the group members it still contains some bugs and offers many optimization options.

Expand All @@ -29,6 +29,14 @@ The application was developed as part of the Software Engineering 2 module in a
<img src="https://github.com/TeamGruenbaum/HofUniversityManager/blob/main/screenshots/add_task_dark.png" width="45%" border=0>
</p>

## Developers
- [Steven Solleder](https://github.com/stevensolleder): Mainly responsible for architecture, controller and also some UI parts
- [Patrick Dressel](https://github.com/patdre): Mainly responsible for the UI, especially the darkmode and view controllers
- [Isabell Waas](https://github.com/isabellwaas): Mainly responsible for parsing data and some model parts
- [Vincent Tischler](https://github.com/Schnowflake): Mainly responsible for downloading and packaging
- [Marcel Stürzenberger](https://github.com/1M4rc3l1): Mainly responsible for creating some model parts
<br>

## Libraries
Following libraries were used:
- [LibFX](https://github.com/nipafx/LibFX)
Expand All @@ -37,5 +45,10 @@ Following libraries were used:
- [JSON-java](https://github.com/stleary/JSON-java)
<br>

## Licensing
The application can be used as a basis for student administration programs of other universities but these projects have to refer explicitly to this repository and its developers.
<br>
<br>

## Get in contact
Feel free to get in contact and share your experience with **HofUniversityManager**. Bug reports are also very appreciated.

0 comments on commit cd4896a

Please # to comment.