Skip to content

Commit 7933269

Browse files
committed
doc: Update README.md, moving stuff around
1 parent 409f3f9 commit 7933269

1 file changed

Lines changed: 30 additions & 22 deletions

File tree

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ and [studentcatering.cz](http://studentcatering.cz/jidelni-listek/) websites
77
in a much more pleasant and usable way for phones.
88
It shows today's and this week's menu, opening hours, contacts, announcements and addresses for all canteens.
99

10-
Core parts are written in Kotlin Multiplatform, support for JVM target can be added right away. Other targets require more work (non-JVM web scraping library required), but it still may be manageable for somebody to port this codebase to native or js platforms.
11-
12-
See **contributing** below.
13-
1410
##### What does 'Menza' mean?
1511

1612
Menza is the Czech word for school cafeteria.
@@ -21,35 +17,39 @@ Menza is the Czech word for school cafeteria.
2117
- [Menza CLI (LastaApps)](https://github.com/Lastaapps/menza-cli)
2218
- [Menza BE (LastaApps)](https://github.com/Lastaapps/menza-backend)
2319

24-
## Libraries
25-
26-
- AndroidX (Compose, ...)
27-
- ArrowKt
28-
- Decompose
29-
- SQLDelight
30-
- Koin
31-
- Coil-kt
32-
- Ktor
33-
- And more
34-
35-
The core of the all in written in Kotlin Multiplatform!
3620

3721
## Features
3822

3923
- Today's menu + dish details
24+
- Account balance along with low balance warning,
25+
see [tutorial](docs/STRAVNIK_SIGNUP.md) for setup instructions.
4026
- This week's menu
4127
- Menza opening hours, contacts, announcements and addresses
42-
- Account balance, for setup see [tutorial](docs/STRAVNIK_SIGNUP.md)
28+
4329

4430
## User experience
4531

4632
- Dark theme
4733
- Many themes along with support for Android 12 Material You dynamic theming
48-
- Images download switch on metered networks (~0.7 MB per image)
4934
- Image caching
35+
- Images download switch on metered networks (~0.7 MB per image)
5036
- No private data collection
5137
- Proper landscape mode and large screen device support
5238

39+
## Code, Libraries
40+
41+
Core parts are written in Kotlin Multiplatform,
42+
UI is written using Jetpack Compose (Android).
43+
44+
- AndroidX (Compose, ...)
45+
- ArrowKt
46+
- Decompose
47+
- SQLDelight
48+
- Koin
49+
- Coil-kt
50+
- Ktor
51+
- Ktlint
52+
- And more
5353

5454
## Screenshots
5555

@@ -59,14 +59,22 @@ The core of the all in written in Kotlin Multiplatform!
5959

6060
## Contributing and project structure
6161

62-
See [CONTRIBUTING.md](docs/CONTRIBUTING.md).
62+
In case you want to help or implement your own feature,
63+
please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) first.
64+
I think this is a great project to lear how does
65+
a simple yet corporate-like app look like,
66+
how code should (should not?) be structured
67+
and how functional approaches can be nicely used in an "imperative" language.
6368

6469
#### Data sources
6570

66-
Most of the data is obtained from the official Agata API, see the documentation [here](https://agata.suz.cvut.cz/jidelnicky/JAPIV2/JAPI-popis.html).
67-
To get your API key, please contact the IT center and don't steal mine, they will be more than happy to give you one.
71+
Most of the data is obtained from the official Agata API,
72+
see the documentation [here](https://agata.suz.cvut.cz/jidelnicky/JAPIV2/JAPI-popis.html).
73+
To get your API key, please contact the IT center and don't steal mine,
74+
they will be more than happy to give you one.
6875

69-
To get FS and FEL buffet data I do scrape their webpages/hardcode info.
76+
To get FS and FEL buffet data,
77+
their webpages are scraped or hardcoded values are used.
7078

7179
## License
7280

0 commit comments

Comments
 (0)