Skip to content

Commit dff5d24

Browse files
authored
Merge pull request #9 from MostafaGazar/develop
Sort out a few issues with README and CONTRIBUTING files
2 parents f1619e5 + c993fad commit dff5d24

File tree

7 files changed

+5
-6
lines changed

7 files changed

+5
-6
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ We use [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/git
99
Workflow
1010
--------
1111
If you would like to contribute to this project, please:
12-
- Pick an [issue](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/issues) to work on or create a [proposal](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android#feature-proposals) for a new feature.
12+
- Pick an [issue](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/issues) to work on or create a [proposal](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/blob/master/CONTRIBUTING.md#feature-proposals) for a new feature.
1313
- Fork this project.
1414
- Create your feature branch based off the `develop` branch.
1515
- Create a pull request to get your worked reviewed and merged back into the upstream `develop` branch.

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ Getting Started
99
The app has 2 build types: debug and release with minor differences between both builds. [`Stetho`](http://facebook.github.io/stetho/) for example is only enabled for debug builds. And [`Timber`](https://github.com/JakeWharton/timber) to log warnings and errors as Crashlytics non-fatal crashes in release builds.
1010

1111
We also use different app icons for debug and release builds and you can keep both builds on your device and run them side by side.
12+
1213
![](screenshots/debug-release-icons.png)
1314

15+
1416
The app is 100% [Kotlin](http://kotlinlang.org) and we think it is better to keep it this way.
1517

1618
We use [`Koin`](https://insert-koin.io) which is a lightweight dependency injection framework to manage all dependencies. And [`Kotlin Coroutines`](https://kotlinlang.org/docs/reference/coroutines-overview.html) for asynchronous work. We also use `Kotlin Coroutines` with [`Room`](https://developer.android.com/topic/libraries/architecture/room) and [`Retrofit`](https://square.github.io/retrofit/).
@@ -29,10 +31,7 @@ And then compile the project with Gradle using
2931

3032
Screenshots
3133
-----------
32-
![](screenshots/1.png)
33-
![](screenshots/2.png)
34-
![](screenshots/3.png)
35-
![](screenshots/4.png)
34+
![App screenshots](screenshots/app_screenshots.png)
3635

3736
Libraries Used
3837
--------------
@@ -73,7 +72,7 @@ Libraries Used
7372

7473
Upcoming features
7574
-----------------
76-
Interested in seeing a particular feature implemented in this app? Please open a new [issue](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/issues) with a [feature proposal](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android#feature-proposals).
75+
Interested in seeing a particular feature implemented in this app? Please open a new [issue](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/issues) with a [feature proposal](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/blob/master/CONTRIBUTING.md#feature-proposals).
7776

7877
Contributing
7978
------------

screenshots/1.png

-167 KB
Binary file not shown.

screenshots/2.png

-182 KB
Binary file not shown.

screenshots/3.png

-134 KB
Binary file not shown.

screenshots/4.png

-55.9 KB
Binary file not shown.

screenshots/app_screenshots.png

231 KB
Loading

0 commit comments

Comments
 (0)