Skip to content

Commit 94f87d3

Browse files
authored
Update README.md
1 parent 4630cf8 commit 94f87d3

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Simple Weather
22
[![Build Status](https://travis-ci.org/Sparker0i/Weather.svg?branch=master)](https://travis-ci.org/Sparker0i/Weather)
33
[![Release](https://img.shields.io/github/release/Sparker0i/Weather.svg)](https://github.com/Sparker0i/Weather/releases)
4-
[![License](https://img.shields.io/badge/license-GNU_GPLv3-orange.svg)](https://raw.githubusercontent.com/Sparker0i/Weather/HEAD/LICENSE) [![Join the chat at https://gitter.im/SimpleWeather/Lobby](https://badges.gitter.im/SimpleWeather/Lobby.svg)](https://gitter.im/SimpleWeather/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
[![License](https://img.shields.io/badge/license-GNU_GPLv3-orange.svg)](https://raw.githubusercontent.com/Sparker0i/Weather/HEAD/LICENSE)
5+
[![Join the chat at https://gitter.im/SimpleWeather/Lobby](https://badges.gitter.im/SimpleWeather/Lobby.svg)](https://gitter.im/SimpleWeather/Lobby)
56

67
Welcome to my Open Source, easy to use Weather app, built using Android Studio for Android 4.1+
78

@@ -11,20 +12,45 @@ Get it on Google Play and F-Droid (coming soon in XDA Labs Marketplace):
1112
[<img src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' alt='Get it on Google Play' width='210' height='80'>](https://play.google.com/store/apps/details?id=com.a5corp.weather)
1213
[<img src='img/xda.png' width='210' height='80' alt="Get it on XDA Labs">](https://labs.xda-developers.com/store/app/com.a5corp.weather)
1314

15+
## Communication
16+
Our chat channel is on gitter [here](https://gitter.im/SimpleWeather/Lobby)
17+
18+
19+
20+
## Setting up the Android Project
21+
22+
1. Download the project source. You can do this either by forking and cloning the repository (recommended if you plan on pushing changes) or by downloading it as a ZIP file and extracting it.
23+
24+
2. Open Android Studio
25+
26+
3. Open this project by clicking on Open, then navigate to the directory where you cloned this repository, select the root folder of the project, and hit OK. Android Studio should now begin building the project with Gradle.
27+
28+
4. Once this process is complete and Android Studio opens, check the Console for any build errors.
29+
30+
- _Note:_ If you receive a Gradle sync error titled, "failed to find ...", you should click on the link below the error message (if avaliable) that says _Install missing platform(s) and sync project_ and allow Android studio to fetch you what is missing.
31+
32+
5. Once all build errors have been resolved, you should be all set to build the app and test it.
33+
34+
6. To Build the app, go to _Build>Make Project_ (or alternatively press the Make Project icon in the toolbar).
35+
36+
7. If the app was built successfully, you can test it by running it on either a real device or an emulated one by going to _Run>Run 'app'_ or pressing the Run icon in the toolbar.
37+
1438
## Changelog
1539
Please refer CHANGELOG.md file.
1640

1741
## Translators
1842
If you want to translate you can easily do so on [Transifex](https://www.transifex.com/a5-corp/simple-weather).
1943

2044
## Contributing
45+
- Fork this repo
46+
- Clone your forked repo
2147
- Create a new PR with a feature you want to add (though this depends upon the discretion of the developer, ie. me), or fix a bug in an already existing feature
2248

2349
![Weather App](/img/App.png)
2450

2551
## License
2652
```
27-
Simple Weather. App displays weather information in a beautiful manner.
53+
Simple Weather. App displays weather information in a nice manner.
2854
Copyright (C) 2015-2017 Aaditya Menon <[email protected]>
2955
3056
This program is free software: you can redistribute it and/or modify

0 commit comments

Comments
 (0)