File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -6,11 +6,12 @@ A smart study planner that builds your revision schedule automatically based on
66- Input your exams with dates and estimated study hours
77- Set daily available study hours and commitments
88- Import commitments automatically from Google Calendar
9- - Edit/ commitments inside the planner
10- - Get an automatically generated color coded revision schedule
9+ - Edit commitments inside the planner
10+ - Get an automatically generated color coded study schedule
1111- Receive warnings when there is not enough time for an exam
12+ - Export study schedule to Google Calendar
1213- Get personalised study tips based on psychology research
13- - Optional spaced repetition schedule based on the Ebbinghaus forgetting curve
14+ - Optional: spaced repetition schedule based on the Ebbinghaus forgetting curve
1415
1516## Installation
1617``` bash
Original file line number Diff line number Diff line change 9999 "source": [
100100 "## Software Flowchart\n",
101101 "\n",
102- "This is how build_schedule processes her inputs:\n",
102+ "### Software Flowchart — Main Functions\n",
103+ "\n",
104+ "```mermaid\n",
105+ "flowchart TD\n",
106+ " A[app.py\\nDash Web App] --> B[build_schedule\\nschedule.py]\n",
107+ " A --> C[generate_tips\\nschedule.py]\n",
108+ " A --> D[get_subject_color_map\\napp.py]\n",
109+ " A --> E[build_chart\\napp.py]\n",
110+ " A --> F[build_weekly_view\\napp.py]\n",
111+ " A --> G[import_commitments_from_google_calendar\\ngoogle_calendar.py]\n",
112+ " A --> H[export_schedule_to_google_calendar\\ngoogle_calendar.py]\n",
113+ " B --> I[_available_hours_per_day\\nschedule.py]\n",
114+ " B --> J[_round_to_half\\nschedule.py]\n",
115+ " B --> K[_schedule_reviews\\nschedule.py]\n",
116+ "```\n",
117+ "\n",
118+ "### build_schedule — Internal Algorithm\n",
103119 "\n",
104120 "```mermaid\n",
105121 "flowchart TD\n",
You can’t perform that action at this time.
0 commit comments