Commit c0fdb9ee authored by Martin Finkel's avatar Martin Finkel

doc: Add LibVLCSharp.Forms README

parent 608fb383
# LibVLCSharp.Forms
[![NuGet Stats](https://img.shields.io/nuget/v/LibVLCSharp.Forms.svg)](https://www.nuget.org/packages/LibVLCSharp.Forms)
[![NuGet Stats](https://img.shields.io/nuget/dt/LibVLCSharp.Forms.svg)](https://www.nuget.org/packages/LibVLCSharp.Forms)
This package provides Xamarin.Forms for LibVLCSharp by providing custom renderers.
This package also contains the views for the following platforms:
- Android
- iOS
- Mac
[GTK](../LibVLCSharp.Forms.Platforms.GTK/README.md) and [WPF](../LibVLCSharp.Forms.Platforms.WPF/README.md) Forms support are in separate packages due to multi-targetting limitations. You still need to install `LibVLCSharp.Forms` if you target those platforms.
This package has multiple target frameworks, which means it will pick the right features for your project (you will only get the mac view if you are building a mac project).
BE CAREFUL: This project does not include **LibVLC** itself! You will need to install it separately!
See the [Installation](../README.md#installation) documentation for more info.
## Why should I reference this package in my project?
If you are in one of these situation, this package is made for you.
- You want to build a Xamarin.Forms application (no matter on which platform)
For other platforms, see the [main documentation](../README.md)
\ No newline at end of file
Markdown is supported
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