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/)