news-android/README.md

ownCloud News Reader - Android App
==================================
The ownCloud News Reader Android App is under AGPLv3 License terms.  
Status: Beta  
Bugs and enhancements can be reported under: https://github.com/owncloud/News-Android-App/issues

<p>
<a href="https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader" alt="Download from Google Play">
  <img src="http://www.android.com/images/brand/android_app_on_play_large.png">
</a>

<a href="https://f-droid.org/repository/browse/?fdfilter=ownCloud%20News&fdid=de.luhmer.owncloudnewsreader" alt="ownCloud News App on fdroid.org">
  <img src="https://f-droid.org/wiki/images/fdroid-135.png" width="80" height="80" >
</a>
</p>


Donate
==================================
[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=david-dev&url=https://github.com/owncloud/News-Android-App&title=News-Android-App&language=JAVA&tags=github&category=software)


How to use the Beta App via Google Play ?
==================================
Please update your News App and Appframework to the latest version which is only available on GitHub.  

ownCloud News App:
https://github.com/owncloud/news  

Appframework:
https://github.com/owncloud/appframework


After this, join the following Google Group:
https://groups.google.com/d/forum/owncloud-news-android-app
there you can find a link to Google Play for registering as beta tester of the app.


Language
==================================
Is your language not supported yet ?  
You can add your language easily on:  
https://www.transifex.com/projects/p/owncloud/resource/android-news/


FAQ:
==================================
The app shows an empty Toast when trying to sync or sign-in (little dark box at the button of the screen)  
- Make sure you're using the latest version of the news app and the appframework from GitHub. Otherwise you can use the Android version <= 0.3.3 (via Google Play or GitHub <a href="https://github.com/owncloud/News-Android-App/commits/master/OwncloudNewsReader.apk">Choose version</a>).  


Roadmap
==================================
My ToDo List is available on: http://www.strikeapp.com/#z6679l3t


How to compile the App
==================================
Requirements:  
-----------------------
>1) Eclipse + ADT Plugin + Android SDK installed  
>2) Git installed (you can do the following stuff without git but I'm not going to show how).  

Download and install:  
-----------------------
>1) Open cmd/terminal  
>2) Navigate to your workspace   
>3) Then type in:  
><pre>
git clone https://github.com/JakeWharton/ActionBarSherlock.git
git clone https://github.com/David-Development/Android-PullToRefresh.git
git clone https://github.com/owncloud/News-Android-App.git
></pre>

>Go to Eclipse and do the following:  
>--> File --> Import --> Android Project from Exsisting Source --> [...]/ActionBarSherlock/actionbarsherlock  
>--> File --> Import --> Android Project from Exsisting Source --> [...]/Android-PullToRefresh/library  
>--> File --> Import --> Android Project from Exsisting Source --> [...]/News-Android-App  


>Then make a right click on the News-Android-App Project and select "Properties". Select the tab "Android". In this Window you should see the Project Build Target at the top and Libarys at the buttom of the window. Two of them are maybe marked with a read cross. So remove them and add the ActionBarSherlock and the Android PullToRefresh Libary  


>If you get this error message:  
>"Found 2 versions of android-support-v4.jar in the dependency list, but not all the versions are identical (check is based on SHA-1 only at  this time)." try to copy the [...]/News-Android-App/libs/android-support-v4.jar file to [...]/ActionBarSherlock/actionbarsherlock/android-support-v4.jar  

>That's all. I hope it works for you! If something is not working, please send me an email to david-dev@live.de


Updates
==================================
0.4.0 (in development)
---------------------
- Fixed app crash when image cache is enabled and the dialog appear which asks the user if download via roaming is allowed.
- Fixed app crash reports.
- Fixed Issue <a href="https://github.com/owncloud/News-Android-App/issues/96">#96 (Can't sync feeds - using a bad URL)</a>
- Improved <a href="https://github.com/owncloud/News-Android-App/issues/95">#95 Make font/font size user selectable</a>
- Improved <a href="https://github.com/owncloud/News-Android-App/issues/86">#86 clearing the cache while having read items prevents them from being synced</a>
- Implemented Feature <a href="https://github.com/owncloud/News-Android-App/issues/99">#99 Option to change item order new-old/old-new</a>

0.3.9
---------------------
- Support for APIv1 and APIv2. (That means the app on Google Play will be updated, too!)
- Small fixes
- Improved memory usage while synchronizing
- Auto sync of item state every 5 minutes
- Changed font style to Roboto Light

0.3.8
---------------------
- Fixed Issue when trying to download more items in "all unread" and "starred items" view.
- Added option to set up the maximum cache size.
- Fixed app crash on tablets (could crash somtimes since v.0.3.7 when trying to download more items).
- Fixed Issue <a href="https://github.com/owncloud/News-Android-App/issues/78">#78 (The cache should be cleared in the background)</a>
- Improved feature <a href="https://github.com/owncloud/News-Android-App/issues/84">#84 (Buttons to toggle the folders are hard to hit and not descriptive)</a>
- Improved feature <a href="https://github.com/owncloud/News-Android-App/issues/76">#76 (There should me more spacing between feeds and folders)</a>
- Speed optimizations in the Folder/Feed Overview
- About/Changelog added


0.3.7
---------------------
- Option to mark articles as read while scrolling <a href="https://github.com/owncloud/News-Android-App/issues/14">#14 ("mark as read" on scroll)</a>
- Rich list theme layout (WebView) <a href="https://github.com/owncloud/News-Android-App/issues/6">#6</a>
- Fixed issue <a href="https://github.com/owncloud/News-Android-App/issues/46">#46 (Android 3.2.1 crash)</a>
- Fixed issue <a href="https://github.com/owncloud/News-Android-App/issues/68">#68 (Special folder "all unread articles" shows all articles)</a>
- Fixed issue <a href="https://github.com/owncloud/News-Android-App/issues/69">#69 (Crash when image cache enabled)</a>

0.3.6
---------------------
- Option to scroll through articles with Volume rockers <a href="https://github.com/owncloud/News-Android-App/issues/61">#61 (Use volume rocker to browse through articles)</a>
- Option to download old items for feed/folder <a href="https://github.com/owncloud/News-Android-App/issues/63">#63 (Allow dowloading old items)</a>
- Light Theme for item view <a href="https://github.com/owncloud/News-Android-App/issues/59">#59 (White Theme doesn't apply to articles)</a>
- Image offline caching function asks now if you want to download if you're not connected with wifi
- Item detail optimizations

0.3.5
---------------------
- Fixed issue <a href="https://github.com/owncloud/News-Android-App/issues/52">#52 (Folders visible multiple times)</a>  
- Fixed issue <a href="https://github.com/owncloud/News-Android-App/issues/53">#53 (New items get added at the bottom)</a>  
- Added default feed favIcon
- Theme is now also applied in the settings screen
- Implemented <a href="https://github.com/owncloud/News-Android-App/issues/56">#56 (Click on header to open article in browser)</a>  

0.3.4
---------------------
- Offline reading (Only when you sync items the marked/starred/unread/unstarred items get synchronized. This save a lot of network traffic
- Offline image caching
- Login is getting verified when you click sign-in
- Strict-Hostname-Verification (Important Security Fix)
- Simple or extended list view
- Light or dark app Theme
- Implemented <a href="https://github.com/owncloud/News-Android-App/issues/29">#29 Mark all Article in one Column as readed</a>
- A lot of other new stuff and fixes

0.3.3
---------------------
- Dark/Light App Theme   
- Feed List Design Simple/Extended   
- many new languages have been added   

0.3.2
---------------------
- Fixed app crash when leaving item detail view.   

0.3.1
---------------------
- Polish language support added (thank you for translating Cyryl)   
- App crash fixed when no item header text is available   
- Go back in the item view if you press the home button   
- Added Up Button in detail view as fix for GitHub Issue #13    
- Other small fixes    

0.3.0
---------------------
- Android 2.2+ Support added    
- small bugfixes