diff options
author | Orangerot <purple@orangerot.dev> | 2024-08-16 22:47:22 +0200 |
---|---|---|
committer | Orangerot <purple@orangerot.dev> | 2024-08-26 11:19:38 +0200 |
commit | 2aea4f96f5c2daf6ca0d237ca2288c6a767cdeeb (patch) | |
tree | 3d3c822fa38afba124763d0af25ac0287337f050 /README.md | |
parent | cbdd9391dfe3b6485ba1c8a503bc4dd08398a30d (diff) |
feat(README): explaination
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -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 <table> |