Skip to content

Commit 05849b4

Browse files
committed
Update README.md
1 parent 1723c03 commit 05849b4

File tree

2 files changed

+25
-66
lines changed

2 files changed

+25
-66
lines changed

README-template.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
1-
# Template repository
2-
3-
Template repository for the Jetpack Compose [#AndroidDevChallenge](https://developer.android.com/dev-challenge).
4-
5-
## Getting started
6-
Copy this repository by pressing the "Use this template" button in Github.
7-
Clone your repository and open it in the latest [Android Studio (Canary build)](https://developer.android.com/studio/preview).
8-
9-
## Submission requirements
10-
- Follow the challenge description on the project website: [developer.android.com/dev-challenge](https://developer.android.com/dev-challenge)
11-
- All UI should be written using Jetpack Compose
12-
- The Github Actions workflow should complete successfully
13-
- Include two screenshots of your submission in the [results](results) folder. The names should be
14-
screenshot_1.png and screenshot_2.png.
15-
- Include a screen record of your submission in the [results](results) folder. The name should be
16-
video.mp4
17-
- Replace the contents of [README.md](README.md) with the contents of [README-template.md](README-template.md) and fill out the template.
18-
19-
## Code formatting
20-
The CI uses [Spotless](https://github.com/diffplug/spotless) to check if your code is formatted correctly and contains the right licenses.
21-
Internally, Spotless uses [ktlint](https://github.com/pinterest/ktlint) to check the formatting of your code.
22-
To set up ktlint correctly with Android Studio, follow one of the [listed setup options](https://github.com/pinterest/ktlint#-with-intellij-idea).
23-
24-
Before committing your code, run `./gradlew app:spotlessApply` to automatically format your code.
1+
# Put title of your app here
2+
3+
4+
![Workflow result](https://github.com/FlodCoding/Weather-Challenge/workflows/Check/badge.svg)
5+
6+
7+
## :scroll: Description
8+
A simple and beautiful weather app, intuitively and dynamically show the current weather
9+
10+
11+
## :bulb: Motivation and Context
12+
<!--- Optionally point readers to interesting parts of your submission. -->
13+
<!--- What are you especially proud of? -->
14+
- Seven kinds animated weather
15+
- Scrollable temperature curve chart
16+
- Light & dark themes
17+
18+
19+
## :camera_flash: Screenshots
20+
<!-- You can add more screenshots here if you like -->
21+
<img src="/results/screenshot_1.png" width="260">&emsp;<img src="/results/screenshot_2.png" width="260">
22+
23+
<img src="/results/screenshot_3.png" width="260">&emsp;<img src="/results/screenshot_4.png" width="260">
24+
25+
<img src="/results/screenshot_5.png" width="260">
2526

2627
## License
2728
```

0 commit comments

Comments
 (0)