diff --git a/README.md b/README.md new file mode 100644 index 000000000..d4271ea05 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# VLC for Android +This is the official Android port of VLC. + +## License +VLC for Android is licensed under GPLv3 + +## Build + +You will need a recent Linux distribution to build VLC. +It should work with Windows 10, but no official support for this. + +Check our [AndroidCompile wiki page](https://wiki.videolan.org/AndroidCompile/) + +## Contribute + +VLC is a libre and open source project, we welcome all contributions. + +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. + +### 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 have a look at our [sample codes](https://code.videolan.org/videolan/libvlc-android-samples). + +## support + +- Android mailing list: android@videolan.org +- IRC: *#videolan* channel on [freenode](http://freenode.net/)