From 396aa7524830324bf41e2ae1714c3a495111a441 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Kempf Date: Sun, 16 Dec 2018 16:29:21 +0100 Subject: [PATCH] Update the README file --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e34b80d5c..8bbf787fb 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ # VLC for Android -This is the official Android port of VLC. +This is the official **Android** port of [VLC](https://videolan.org/vlc/). + +VLC on Android plays all the same files as the classical version of VLC, and features a media database +for Audio and Video files and stream. ## License -VLC for Android is licensed under GPLv3 +VLC for Android is licensed under GPLv2 (or later). Android libraries makes this, de facto, a GPLv3 application. + +VLC engine *(libvlc)* for Android is licensed under LGPL. ## Build You will need a recent Linux distribution to build VLC. -It should work with Windows 10, but no official support for this. +It should work with Windows 10, and macOS, but there is no official support for this. Check our [AndroidCompile wiki page](https://wiki.videolan.org/AndroidCompile/) @@ -15,25 +20,27 @@ Check our [AndroidCompile wiki page](https://wiki.videolan.org/AndroidCompile/) VLC is a libre and open source project, we welcome all contributions. +Just respect our [Code of Conduct](https://wiki.videolan.org/CoC/). + ### Pull requests -Pull requests can be proposed on [github mirror](https://github.com/videolan/vlc-android) as code.videolan.org is reserved to VideoLAN members +Pull requests can be proposed here or on our [github mirror](https://github.com/videolan/vlc-android). ### Sending patches to the mailing list -Check [our wiki page on how to send patches](https://wiki.videolan.org/Sending_Patches_VLC/) +Check [our wiki page on how to send patches](https://wiki.videolan.org/Sending_Patches_VLC/) Send them to the android mailing list: android@videolan.org, not vlc-devel. ## Issues and feature requests -VLC for Android bugtracker is hosted on [VideoLAN gitlab](https://code.videolan.org/videolan/vlc-android/issues) +VLC for Android bugtracker is hosted on [VideoLAN gitlab](https://code.videolan.org/videolan/vlc-android/issues) Please look for existing issues and provide as much useful details as you can (e.g. vlc app version, device and Android version) -### Translations: +### Translations: You can help improving translations too by joining the [transifex vlc project](https://www.transifex.com/yaron/vlc-trans/dashboard/) ## LibVLC -You can use our LibVLC module to power your own Android media player. +You can use our LibVLC module to power your own Android media player. Have a look at our [sample codes](https://code.videolan.org/videolan/libvlc-android-samples). ## support @@ -41,5 +48,6 @@ Have a look at our [sample codes](https://code.videolan.org/videolan/libvlc-and - Android mailing list: android@videolan.org - bugtracker: https://code.videolan.org/videolan/vlc-android/issues - IRC: *#videolan* channel on [freenode](http://freenode.net/) -- forum: https://forum.videolan.org/ +- VideoLAN forum: https://forum.videolan.org/ - G+ community: https://plus.google.com/u/0/communities/113615952107012455563 +