README.md 2.17 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 8 9
![splash screen](./fastlane/metadata/android/en-US/images/phoneScreenshots/1-splash-screen.png) ![login page](./fastlane/metadata/android/en-US/images/phoneScreenshots/2-login.png)  

![landing all](./fastlane/metadata/android/en-US/images/phoneScreenshots/3-landing-all.png) ![landing unread](./fastlane/metadata/android/en-US/images/phoneScreenshots/4-landing-unread.png)  

![subscription articles](./fastlane/metadata/android/en-US/images/phoneScreenshots/5-subscription-articles.png) ![article details](./fastlane/metadata/android/en-US/images/phoneScreenshots/6-article-detail.png)
Christophe Henry's avatar
Christophe Henry committed
10

11 12
![add feed panel](./fastlane/metadata/android/en-US/images/phoneScreenshots/11-add-feed.png)

13 14 15
## 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 
16
anonymously on the [`#freshrss`](https://kiwiirc.com/nextclient/chat.freenode.net:7070/freshrss) IRC channel on Freenode servers.
17

18 19 20 21 22 23 24
## 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

25
This project has no tests yet ¯\\\_(ツ)\_
26 27 28 29 30
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

31
 Please refer to the [contributing guide](./CONTRIBUTING.md)
32 33 34 35 36 37 38 39 40 41

## 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.