README.md 1.94 KB
Newer Older
1 2 3 4
# FreshRSS Android application

Finally, an Android application specifically dedicated to the awesome [FreshRSS aggregator](https://freshrss.org/)

5 6 7
![splash screen](./fastlane/metadata/android/en-US/images/phoneScreenshots/splash-screen.png)  
![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)
Christophe Henry's avatar
Christophe Henry committed
8

9 10 11 12 13
## 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/)).

14 15 16 17 18 19 20
## 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/), 
everything should be fine.

## Running the tests

21
This project has no tests yet ¯\\\_(ツ)\_
22 23 24 25 26
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

27
 Please refer to the [contributing guide](./CONTRIBUTING.md)
28 29 30 31 32 33 34 35 36 37

## License

This project is licenced under GNU GPL v.3. See [LICENSE](https://git.feneas.org/christophehenry/freshrss-android/blob/develop/LICENSE).

## Aknowledgments

Thanks to [Marien Fressinaud](https://github.com/marienfressinaud), 
[Alexandre Alapetite](https://github.com/Alkarex) and all the FreshRSS contributors for their awesome work. 
And thanks again to Alexandre for helping in understanding their implementation of Google reader's API.