Commit 3dfc711e authored by Martin Finkel's avatar Martin Finkel
Browse files

readme: fix formatting

parent 931475eb
# VLC for Android # VLC for Android
This is the official **Android** port of [VLC](https://videolan.org/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 VLC on Android plays all the same files as the classical version of VLC, and features a media database
...@@ -19,6 +20,7 @@ for Audio and Video files and stream. ...@@ -19,6 +20,7 @@ for Audio and Video files and stream.
## Project Structure ## Project Structure
Here are the current folders of vlc-android project: Here are the current folders of vlc-android project:
- extension-api : Application extensions SDK (not released yet) - extension-api : Application extensions SDK (not released yet)
- application : Android application source code, organized by modules. - application : Android application source code, organized by modules.
- buildsystem : Build scripts, CI and maven publication configuration - buildsystem : Build scripts, CI and maven publication configuration
...@@ -46,8 +48,8 @@ And more. ...@@ -46,8 +48,8 @@ And more.
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). Have a look at our [sample codes](https://code.videolan.org/videolan/libvlc-android-samples).
## License ## License
VLC for Android is licensed under [GPLv2 (or later)](COPYING). Android libraries make this, de facto, a GPLv3 application. VLC for Android is licensed under [GPLv2 (or later)](COPYING). Android libraries make this, de facto, a GPLv3 application.
VLC engine *(LibVLC)* for Android is licensed under [LGPLv2](libvlc/COPYING.LIB). VLC engine *(LibVLC)* for Android is licensed under [LGPLv2](libvlc/COPYING.LIB).
...@@ -55,6 +57,7 @@ VLC engine *(LibVLC)* for Android is licensed under [LGPLv2](libvlc/COPYING.LIB) ...@@ -55,6 +57,7 @@ VLC engine *(LibVLC)* for Android is licensed under [LGPLv2](libvlc/COPYING.LIB)
## Build ## Build
Native libraries are published on bintray. So you can: Native libraries are published on bintray. So you can:
- Build the application and get libraries via gradle dependencies (JVM build only) - Build the application and get libraries via gradle dependencies (JVM build only)
- Build the whole app (LibVLC + Medialibrary + Application) - Build the whole app (LibVLC + Medialibrary + Application)
- Build LibVLC only, and get an .aar package - Build LibVLC only, and get an .aar package
...@@ -62,6 +65,7 @@ Native libraries are published on bintray. So you can: ...@@ -62,6 +65,7 @@ Native libraries are published on bintray. So you can:
### Build Application ### Build Application
VLC-Android build relies on gradle build modes : VLC-Android build relies on gradle build modes :
- `Release` & `Debug` will get LibVLC and Medialibrary from Bintray, and build application source code only. - `Release` & `Debug` will get LibVLC and Medialibrary from Bintray, and build application source code only.
- `SignedRelease` also, but it will allow you to sign application apk with a local keystore. - `SignedRelease` also, but it will allow you to sign application apk with a local keystore.
- `Dev` will build build LibVLC, Medialibrary, and then build the application with these binaries. (via build scripts only) - `Dev` will build build LibVLC, Medialibrary, and then build the application with these binaries. (via build scripts only)
...@@ -78,7 +82,7 @@ Check our [AndroidCompile wiki page](https://wiki.videolan.org/AndroidCompile/), ...@@ -78,7 +82,7 @@ Check our [AndroidCompile wiki page](https://wiki.videolan.org/AndroidCompile/),
Here are the essential points: Here are the essential points:
On Debian/Ubuntu, install the required dependencies: On Debian/Ubuntu, install the required dependencies:
``` ```bash
sudo apt install automake ant autopoint cmake build-essential libtool-bin \ sudo apt install automake ant autopoint cmake build-essential libtool-bin \
patch pkg-config protobuf-compiler ragel subversion unzip git \ patch pkg-config protobuf-compiler ragel subversion unzip git \
openjdk-8-jre openjdk-8-jdk flex python wget openjdk-8-jre openjdk-8-jdk flex python wget
...@@ -97,7 +101,6 @@ Then, you are ready to build! ...@@ -97,7 +101,6 @@ Then, you are ready to build!
`buildsystem/compile.sh -l -a <ABI>` `buildsystem/compile.sh -l -a <ABI>`
ABI can be `arm`, `arm64`, `x86`, `x86_64` or `all` for a multi-abis build ABI can be `arm`, `arm64`, `x86`, `x86_64` or `all` for a multi-abis build
You can do a library release build with `-r` argument You can do a library release build with `-r` argument
...@@ -118,7 +121,7 @@ Pull requests must be proposed on our [gitlab server](https://code.videolan.org/ ...@@ -118,7 +121,7 @@ Pull requests must be proposed on our [gitlab server](https://code.videolan.org/
So you must create an account, fork vlc-android project, and propose your merge requests from it. So you must create an account, fork vlc-android project, and propose your merge requests from it.
**Exept for translations**, see the section below. **Except for translations**, see the section below.
### Translations ### Translations
...@@ -133,12 +136,11 @@ Please look for existing issues and provide as much useful details as you can (e ...@@ -133,12 +136,11 @@ Please look for existing issues and provide as much useful details as you can (e
A template is provided, please use it! A template is provided, please use it!
Issues without relevant informations will be ignored, we cannot help in this case. Issues without relevant information will be ignored, we cannot help in this case.
## Support ## Support
- Android mailing list: android@videolan.org - Android mailing list: android@videolan.org
- bugtracker: https://code.videolan.org/videolan/vlc-android/issues - bugtracker: https://code.videolan.org/videolan/vlc-android/issues
- IRC: *#videolan* channel on [freenode](http://freenode.net/) - IRC: *#videolan* channel on [freenode](http://freenode.net/)
- VideoLAN forum: https://forum.videolan.org/ - VideoLAN forum: https://forum.videolan.org/
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment