From 173ce00cf29822294137d3ebacc5b33ad01a3d25 Mon Sep 17 00:00:00 2001 From: Orangerot Date: Fri, 16 Aug 2024 22:47:22 +0200 Subject: feat(README): explaination --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 4c77758..8a9cdc5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,26 @@ # Olympia 2024 Events > View updated Events with its Competitors and Rankings of all Disciplines +*Olympia 2024 Events* always displays up to date information of the 2024 +Olympics in Paris. It achieves this by fetching the `olympics.com` API. + +We use the Model-View-Delegate pattern to synchronize the API data in C++ with +the UI-Widgets defined in QML. For this we implement the API data as a Model +which can be seen and interacted with by QML Components. + +All code, qml definitions and images, etc are compiled into a single binary that +is not dependent on any resources on relative paths anymore. + +On startup the default discipline *Archery* will be fetched and shown on the +EventsPage. From here the user has three options. You can change the discipline +from the Dropdown-Menu (Combobox) in the top left (also note the changing +pictograms of the discipline); Filter the EventNames with the Search field in +the top right; or click on an Event. + +When clicking on an Event, the user is redirected to the EventInfoPage. Here you +can see Information about all Competitors that took part in the Event. When you +are done, you can go back to the EventsPage with the button in the top left. + ## Galery -- cgit v1.2.3