Skip to content

Commit 442ff59

Browse files
committed
- Enhance README.md with project description, details, and screenshots.
- Add new tasks to the "Future Enhancements" section. - Include image assets for the banner and app screenshots.
1 parent 536fea9 commit 442ff59

File tree

4 files changed

+37
-16
lines changed

4 files changed

+37
-16
lines changed

README.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,42 @@
1-
This is a Kotlin Multiplatform project targeting Android, iOS, Web, Desktop.
1+
# Kotlin Dictionary 📚
22

3-
* `/composeApp` is for code that will be shared across your Compose Multiplatform applications.
4-
It contains several subfolders:
5-
- `commonMain` is for code that’s common for all targets.
6-
- Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
7-
For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,
8-
`iosMain` would be the right folder for such calls.
3+
![Kotlin Dictionary Banner](assets/banner.png)
94

10-
* `/iosApp` contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform,
11-
you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.
5+
Kotlin Dictionary is a student-led, cross-platform app designed to help learners dive deep into the Kotlin programming language. It serves as an interactive reference where you can explore topics with clear explanations and reinforce your learning through quizzes.
126

7+
---
8+
9+
## About This Project
10+
11+
This project is part of a collaborative learning effort by students passionate about Kotlin, Jetpack Compose, and cross-platform development. It is being built as we explore and experiment with Kotlin Multiplatform capabilities.
12+
13+
We're exploring core Kotlin concepts and building this app as a way to document our journey, reinforce what we learn, and share it with others along the way.
14+
15+
The Kotlin Dictionary project is being guided by [@RajashekarRaju](https://github.com/RajashekarRaju), who mentors contributors throughout the process. This includes:
16+
17+
- Providing architectural guidance
18+
- Reviewing contributions
19+
- Suggesting improvements
20+
- Promoting best practices in Kotlin development
21+
22+
We're all learning together, and the code evolves as we grow!
1323

14-
Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html),
15-
[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform),
16-
[Kotlin/Wasm](https://kotl.in/wasm/)
24+
---
25+
26+
## 📱 Screenshots
27+
28+
Here are a couple of early previews from the Android version of the app:
29+
30+
![Android Screenshot](assets/img_topic_screen.jpg)
31+
![Android Screenshot](assets/img_detail_screen_variables.jpg)
32+
33+
> *More previews coming soon as the UI progresses!*
34+
35+
---
1736

18-
We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack channel [#compose-web](https://slack-chats.kotlinlang.org/c/compose-web).
19-
If you face any issues, please report them on [GitHub](https://github.com/JetBrains/compose-multiplatform/issues).
37+
## ⚠️ Disclaimer
2038

21-
You can open the web application by running the `:composeApp:wasmJsBrowserDevelopmentRun` Gradle task.
39+
This is an educational project developed by students. Expect rapid changes, experiments, and ongoing improvements as part of the learning journey. 😊
2240

2341
---
2442

@@ -34,4 +52,7 @@ You can open the web application by running the `:composeApp:wasmJsBrowserDevelo
3452
- [ ] Introduce common @Preview annotations for reusable Composable previews.
3553
- [ ] Implement section-wise scroll behavior on the `Detail Screen` for better navigation.
3654
- [ ] Add inline code formatting support for syntax display on the `Detail Screen`.
37-
- [ ] Replace the search icon on the `Topic Card` to improve visual consistency.
55+
- [ ] Replace the search icon on the `Topic Card` to improve visual consistency.
56+
- [ ] Implement caching on the `Detail Screen` to store previously viewed topic data.
57+
- [ ] Switch AI integration from OpenAI to Gemini.
58+
- [ ] Refactor network layer for cleaner architecture.

assets/banner.png

3.77 MB
Loading
180 KB
Loading

assets/img_topic_screen.jpg

84.2 KB
Loading

0 commit comments

Comments
 (0)