Commit 5a249c76 authored by Christophe Henry's avatar Christophe Henry

Merge branch 'add-contact-section' into 'develop'

Add contact section to README and move contributing section to CONTRIBUTING

See merge request !21
parents e0e26ae2 adc45cea
......@@ -23,17 +23,48 @@ Never hesitate to seek help among other contributor. Life is all about learning!
# Technique
## Setup
Before you start developing, you should install [Android studio](https://developer.android.com/studio/install),
Android's, integrated development enrionment.
Android's, integrated development environment.
This is a fairly standard Android project. There are a few things to know, though, before contributing...
1. This project is a pure Kotlin project. No Java will be tolerated.
The original author is highly allergic to Java and was very happy to see the Android team embrace Kotlin.
Since Kotlin is becoming the standard to develop Android applications
(Android's support library are being rewritten in Kotlin, Jetpack — the Android library for rapid application development —
is also written in Kotlin, and examples in Android's documentation show Kotlin code by default), this project adopted Kotlin.
2. It also heavily relies on [Jetpack](https://developer.android.com/jetpack/), the Android's rapid application development library.
In particular, it uses:
* [JP's data binding](https://developer.android.com/topic/libraries/data-binding/)
* [`LiveData` classes](https://developer.android.com/topic/libraries/architecture/livedata)
* [Navigation](https://developer.android.com/topic/libraries/architecture/navigation/)
* [Room persistence library](https://developer.android.com/topic/libraries/architecture/room) for database interaction,
* [`ViewModel`s](https://developer.android.com/topic/libraries/architecture/viewmodel)
It would be advised to read [Android's guide to app architecture](https://developer.android.com/jetpack/docs/guide)
3. It uses [Kovenant](http://kovenant.komponents.nl/), as Kotlin promise library to perform async operations.
Read the [contributing section of the README](https://git.feneas.org/christophehenry/freshrss-android#contributing).
4. It uses [Fuel](https://fuel.gitbook.io/documentation/) for HTTP requests.
5. You can debug your application using [Facebook's Stetho](http://facebook.github.io/stetho/).
6. Serialization and deserialization of HTTP request is handled by [Jackson](https://github.com/FasterXML/jackson-core).
## Where to start
Pick [a ticket](https://git.feneas.org/christophehenry/freshrss-android/issues),
preferably, on that is marked for the next release and start working on it.
Apart from application's features and development, this project is severely
lacking tests and a good CI pipeline. Feel free to set them up if you feel
you have the knowledge.
you have the knowledge.
If you are not a developer, you can contribute by localizing the application in your language.
Please read the [Android localization guide](https://developer.android.com/guide/topics/resources/localization).
# Contributors
......
......@@ -6,6 +6,11 @@ Finally, an Android application specifically dedicated to the awesome [FreshRSS
![landing all](./fastlane/metadata/android/en-US/images/phoneScreenshots/landing-all.png)![landing unread](./fastlane/metadata/android/en-US/images/phoneScreenshots/landing-unread.png)
![subscription articles](./fastlane/metadata/android/en-US/images/phoneScreenshots/subscription-articles.png)![article details](./fastlane/metadata/android/en-US/images/phoneScreenshots/article-detail.png)
## Contact & troubleshoot
If you need help for contributing or using the application, you can contact us by [joining us on Framateam](https://framateam.org/signup_user_complete/?id=e2680d3e3128b9fac8fdb3003b0024ee) or
anonymously on the `#freshrss` IRC channel (you can use [Kiwiirc](https://kiwiirc.com/nextclient/)).
## Getting started
This project is a fairly standard Android application. As long as you use an correct setup of [Android studio](https://developer.android.com/studio/),
......@@ -13,36 +18,13 @@ everything should be fine.
## Running the tests
This project has no tests yet ¯\_(ツ)_/¯
This project has no tests yet ¯\\\_(ツ)\_
There is an issue [about setting them up](https://git.feneas.org/christophehenry/freshrss-android/issues/16),
though, as well as one for [setting up a CI](https://git.feneas.org/christophehenry/freshrss-android/issues/17)
## Contributing
As stated, this is a fairly standard Android project. There are a few things to know, though, before contributing...
1. This project is a pure Kotlin project. No Java will be tolerated.
The original author is highly allergic to Java and was very happy to see the Android team embrace Kotlin.
Since Kotlin is becoming the standard to develop Android applications
(Android's support library are being rewritten in Kotlin, Jetpack — the Android library for rapid application development —
is also written in Kotlin, and examples in Android's documentation show Kotlin code by default), this project adopted Kotlin.
2. It also heavily relies on [Jetpack](https://developer.android.com/jetpack/), the Android's rapid application development library.
In particular, it uses:
* [JP's data binding](https://developer.android.com/topic/libraries/data-binding/)
* [`LiveData` classes](https://developer.android.com/topic/libraries/architecture/livedata)
* [Navigation](https://developer.android.com/topic/libraries/architecture/navigation/)
* [Room persistence library](https://developer.android.com/topic/libraries/architecture/room) for database interaction,
* [`ViewModel`s](https://developer.android.com/topic/libraries/architecture/viewmodel)
It would be advised to read [Android's guid to app architecture](https://developer.android.com/jetpack/docs/guide)
3. It uses [Kovenent](http://kovenant.komponents.nl/), as Kotlin promise library to perform async operations.
4. It uses [Fuel](https://fuel.gitbook.io/documentation/) for HTTP requests.
5. You can debug your application using [Facebook's Stetho](http://facebook.github.io/stetho/).
6. Serialization and deserialization of HTTP request is handled by [Jackson](https://github.com/FasterXML/jackson-core).
Please refer to the [contributing guide](./CONTRIBUTING.md)
## License
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment