news-android/README.md

98 lines
4.2 KiB
Markdown
Raw Normal View History

2017-10-22 14:01:10 +00:00
Nextcloud News Reader Android App
2013-06-10 17:31:42 +00:00
==================================
2018-10-21 19:23:06 +00:00
2020-03-18 12:27:40 +00:00
[![Android CI](https://github.com/nextcloud/news-android/workflows/Android%20CI/badge.svg)](https://github.com/nextcloud/news-android/actions)
2018-10-21 19:23:06 +00:00
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2bb65782750445c99e80dab29f6701a6)](https://www.codacy.com/app/Nextcloud/news-android?utm_source=github.com&utm_medium=referral&utm_content=nextcloud/news-android&utm_campaign=Badge_Grade)
2017-10-22 14:01:10 +00:00
The Nextcloud News Reader Android App is under [AGPLv3](https://www.gnu.org/licenses/license-list.html#AGPLv3.0) License terms.
2013-06-10 17:31:42 +00:00
[![Latest Release](https://img.shields.io/github/v/tag/nextcloud/news-android?label=latest+release&sort=semver)](https://github.com/nextcloud/news-android/releases)
[![F-Droid Release](https://img.shields.io/f-droid/v/de.luhmer.owncloudnewsreader)](https://f-droid.org/de/packages/de.luhmer.owncloudnewsreader/)
2013-07-30 10:32:27 +00:00
<p>
2017-11-09 22:17:12 +00:00
<a href='https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'>
2017-11-09 22:33:21 +00:00
<img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' height="100"/>
2013-07-30 07:19:23 +00:00
</a>
2013-07-30 10:32:27 +00:00
2017-11-09 22:29:15 +00:00
<a href="https://f-droid.org/app/de.luhmer.owncloudnewsreader">
2018-10-21 19:23:06 +00:00
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="100">
2013-07-30 10:32:27 +00:00
</a>
</p>
2018-10-21 19:23:06 +00:00
*Bugs and enhancements can be reported under*: https://github.com/nextcloud/news-android/issues
2013-07-30 07:19:23 +00:00
How to use the Beta App via Google Play?
2013-07-06 18:53:27 +00:00
==================================
2017-11-09 22:33:21 +00:00
[Nextcloud News Beta](https://play.google.com/apps/testing/de.luhmer.owncloudnewsreader)
2017-11-09 22:17:12 +00:00
2013-07-06 19:03:20 +00:00
Help to translate
==================================
2018-10-21 19:23:06 +00:00
Have you found a translation error? Or would you like to use Nextcloud News Reader in your
native language?
2018-10-21 19:23:06 +00:00
You can [join the translation team](https://www.transifex.com/nextcloud/nextcloud/) and improve one of over 100 languages (it's the android-news app).
2013-07-15 12:27:33 +00:00
How to compile the App
==================================
Requirements:
2013-07-15 12:27:33 +00:00
-----------------------
2015-11-18 20:44:08 +00:00
1. Android Studio
Download and install:
2013-07-15 12:27:33 +00:00
-----------------------
2015-11-18 20:44:08 +00:00
1. Open cmd/terminal
2. Navigate to your workspace
2019-01-05 09:05:57 +00:00
3. Then type in: `git clone https://github.com/nextcloud/news-android.git`
4. Import the Project in Android Studio and start coding!
2017-05-28 21:39:27 +00:00
2019-04-29 23:30:46 +00:00
Testing with Android Auto:
-----------------------
1. Open Android Studio, click on "Tools" -> "SDK Manager"
2. Select and install "Android Auto API Simulators"
2020-01-07 16:40:46 +00:00
3. Open terminal, go to <android-sdk>/extras/google/simulators (e.g. `cd ~/Library/Android/sdk/extras/google/simulators`)
2019-04-29 23:30:46 +00:00
4. Install apk using adb (`../../../platform-tools/adb install media-browser-simulator.apk`)
5. Install apk using adb (`../../../platform-tools/adb install messaging-simulator.apk`)
2020-01-16 06:04:26 +00:00
Advanced Testing Android Auto (e.g. Voice Features) [Link](https://developer.android.com/training/cars/testing)
-----------------------
1. Install Android 9 in an Emulator (Android 10 didn't work with the Android Auto App)
2. Install Android Auto from PlayStore
3. Follow instructions on training website (see link above)
4. `~/Library/Android/sdk/platform-tools/adb forward tcp:5277 tcp:5277
5. `cd ~/Library/Android/sdk/extras/google/auto`
6. `./desktop-head-unit`
7. From inside the terminal type: `mic play ./voice/pause.wav`
2015-11-18 20:44:08 +00:00
That's all. I hope it works for you! If something is not working, please send me an email to david-dev@live.de
2013-07-15 12:27:33 +00:00
Contributors
==================================
* [David Luhmer](https://github.com/David-Development) (Maintainer)
* [Daniel Schaal](https://github.com/schaal)
2017-01-30 20:17:34 +00:00
* [otrichet](https://github.com/otrichet)
* [cemrich](https://github.com/cemrich)
* [Benjamin Stephan](https://github.com/b3nson)
* [Stefan Niedermann](https://github.com/stefan-niedermann)
* [Nils Griebner](https://github.com/NilsGriebner)
* [AnotherDaniel](https://github.com/AnotherDaniel)
2019-04-06 17:00:19 +00:00
* [Unpublished](https://github.com/Unpublished)
2020-01-07 16:41:48 +00:00
* [emasty](https://github.com/emasty)
2017-10-25 16:10:01 +00:00
2017-11-09 18:30:46 +00:00
Changelog
2013-06-21 21:42:08 +00:00
==================================
2017-11-09 22:33:21 +00:00
- see [CHANGELOG.md](CHANGELOG.md)
2018-10-21 19:23:06 +00:00
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)