Skip to content

Commit 8b68039

Browse files
authored
docs: Revamp README with comprehensive project information and status badges
This commit significantly improves the project's README.md file by: - Integrating a set of informative badges (Build Status, License, Technologies, Repository Stats) for a quick overview. - Reorganizing content into clearer sections: Features, Technologies & Architecture, Screenshots, Getting Started, ML Model Details, License, and Acknowledgements. - Ensuring all instructions for setup (including API key configuration in local.properties) are accurate and easy to follow. - Verifying and updating links to external resources and APIs. - Enhancing the overall visual appeal and professionalism of the project's landing page on GitHub.
1 parent 95acefb commit 8b68039

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Pixel Weather App (Diploma Project)
22

3+
<p align="center">
4+
<!-- Build & Quality -->
5+
<img src="https://img.shields.io/github/actions/workflow/status/ArtemZarubin/PixelArtWeatherML/android.yml?style=for-the-badge&logo=githubactions&logoColor=white" alt="Android CI Build Status"/>
6+
<img src="https://img.shields.io/github/license/ArtemZarubin/PixelArtWeatherML?style=for-the-badge" alt="License" />
7+
<br/>
8+
<!-- Tech Stack -->
9+
<img src="https://img.shields.io/badge/Kotlin-2.1.21-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white" alt="Kotlin Version"/>
10+
<img src="https://img.shields.io/badge/Jetpack%20Compose-BOM%2025.05.01-4285F4?style=for-the-badge&logo=jetpackcompose&logoColor=white" alt="Jetpack Compose" />
11+
<img src="https://img.shields.io/badge/Android%20API-26+-3DDC84?style=for-the-badge&logo=android&logoColor=white" alt="API Level" />
12+
<img src="https://img.shields.io/badge/Architecture-MVVM%20%7C%20Clean-007ACC?style=for-the-badge" alt="Architecture" />
13+
<br/>
14+
<!-- Repository Stats -->
15+
<img src="https://img.shields.io/github/last-commit/ArtemZarubin/PixelArtWeatherML?style=for-the-badge&logo=git&logoColor=white" alt="Last Commit" />
16+
<img src="https://img.shields.io/github/stars/ArtemZarubin/PixelArtWeatherML?style=for-the-badge&logo=github&logoColor=white" alt="Stars" />
17+
<img src="https://img.shields.io/github/forks/ArtemZarubin/PixelArtWeatherML?style=for-the-badge&logo=github&logoColor=white" alt="Forks" />
18+
<img src="https://img.shields.io/github/issues-raw/ArtemZarubin/PixelArtWeatherML?style=for-the-badge&logo=github&logoColor=white" alt="Open Issues" />
19+
<!-- <img src="https://img.shields.io/github/watchers/ArtemZarubin/PixelArtWeatherML?style=for-the-badge&logo=github&logoColor=white" alt="Watchers" /> -->
20+
<!-- <img src="https://img.shields.io/github/languages/top/ArtemZarubin/PixelArtWeatherML?style=for-the-badge" alt="Top Language" /> -->
21+
<!-- <img src="https://img.shields.io/github/languages/count/ArtemZarubin/PixelArtWeatherML?style=for-the-badge" alt="Languages Count" /> -->
22+
</p>
23+
324
<p align="center">
425
<img src="app/src/main/ic_launcher-playstore.png" width="240" alt="App Icon"/><br/>
526
<i>App Icon</i>
@@ -73,9 +94,9 @@ to provide "Feels Like" temperature predictions.
7394

7495
### Prerequisites
7596

76-
* Android Studio (latest stable version recommended, e.g., Hedgehog or newer)
97+
* Android Studio (latest stable version recommended, e.g., Meerkat or newer)
7798
* Android SDK (API Level 26 or higher)
78-
* JDK 17 or higher
99+
* JDK 21 or higher (project is compiled with Java 21 features)
79100

80101
### Installation & Setup
81102

@@ -125,9 +146,7 @@ Celsius.
125146

126147
The complete model training process, including data loading, preprocessing, feature engineering,
127148
model definition, training, and evaluation, can be found in the following Google Colab notebook:
128-
➡️ *
129-
*[View Model Training Notebook on Google Colab](https://colab.research.google.com/drive/1azhbcOYesQdHLMwZ1gLaPV3ceyr5QpX9?usp=sharing)
130-
**
149+
➡️ **[View Model Training Notebook on Google Colab](https://colab.research.google.com/drive/1azhbcOYesQdHLMwZ1gLaPV3ceyr5QpX9?usp=sharing)**
131150

132151
## 📄 License
133152

@@ -137,8 +156,7 @@ This project is licensed under the **MIT License**. See the `LICENSE` file for d
137156

138157
* **OpenWeatherMap** for providing the weather data API.
139158
* **Geoapify** for the geocoding and autocomplete APIs.
140-
* **Dataset:
141-
** ["Historical Weather Data for different cities around the world" from Kaggle](https://www.kaggle.com/datasets/muthuj7/weather-dataset).
159+
* **Dataset:** ["Historical Weather Data for different cities around the world" from Kaggle](https://www.kaggle.com/datasets/muthuj7/weather-dataset).
142160
* **Pixel Fonts:** VCR OSD Mono by Riciery Leal.
143161
* **Icons:**
144162
* Weather Icons: Freepik - Flaticon
@@ -151,4 +169,4 @@ This project is licensed under the **MIT License**. See the `LICENSE` file for d
151169
* Guidance and supervision by Vitaliy I. Gorbenko.
152170
* Google and the Android Jetpack team for the development tools and libraries.
153171

154-
---
172+
---

0 commit comments

Comments
 (0)