StudyPlanner/README.md

# Authors

- Juergen Buechel
- Carla Strassburger
- Jan Wild
- Simon Schurti

# License

    MIT 

# Purpose

Time management optimisation tool.

# How to use

    - to use program directly compile with
          make debug
      . this creates executable binary.

    - to integrate in other software use:
          make release
      . This creates shared library. use StudyPlanner.h (untested)

# Procedure

## User input

- Ask user for subjects and study priority as well as available time to study per day. (days/hours)
- optional deadline for subjects

## Processing

- Use cake cutting algorithm to calculate timetable based on subject priorities and available time.

- output in iCal format

# Responsiilities

- Juergen: ui
- carla: ical
- jan: db
- simon: planner

# Project Overview

  ![Overview Flowchart](doc/overview.png)

sample files in src/

# Datatypes

[planner.h](src/planner.h)