Commit af7fd454 authored by Martin Finkel's avatar Martin Finkel

docs: Add GTK and WPF readmes

parent 1501baa6
# LibVLCSharp.Forms.GTK
[![NuGet Stats](https://img.shields.io/nuget/v/LibVLCSharp.Forms.GTK.svg)](https://www.nuget.org/packages/LibVLCSharp.Forms.GTK)
[![NuGet Stats](https://img.shields.io/nuget/dt/LibVLCSharp.Forms.GTK.svg)](https://www.nuget.org/packages/LibVLCSharp.Forms.GTK)
This package provides Xamarin.Forms support for GTK# apps that use LibVLCSharp.
## Why should I reference this package in my project?
If you are in this situation, this package is made for you:
- You want to have a native GTK app on Windows or Linux that makes use of your shared Xamarin.Forms XAML code.
For other platforms, see the [main documentation](../README.md)
\ No newline at end of file
# LibVLCSharp.Forms.WPF
[![NuGet Stats](https://img.shields.io/nuget/v/LibVLCSharp.Forms.WPF.svg)](https://www.nuget.org/packages/LibVLCSharp.Forms.WPF)
[![NuGet Stats](https://img.shields.io/nuget/dt/LibVLCSharp.Forms.WPF.svg)](https://www.nuget.org/packages/LibVLCSharp.Forms.WPF)
This package provides Xamarin.Forms support for WPF Windows apps that use LibVLCSharp.
## Why should I reference this package in my project?
If you are in this situation, this package is made for you:
- You want to have a native WPF app on Windows that makes use of your shared Xamarin.Forms XAML code.
For other platforms, see the [main documentation](../README.md)
\ No newline at end of file
......@@ -3,7 +3,7 @@
[![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 provides Xamarin.Forms support for LibVLCSharp.
This package also contains the views for the following platforms:
......@@ -11,7 +11,7 @@ This package also contains the views for the following platforms:
- 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.
[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.
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).
......@@ -20,8 +20,8 @@ This package has multiple target frameworks, which means it will pick the right
## Why should I reference this package in my project?
If you are in one of these situation, this package is made for you.
If you are in this situation, this package is made for you:
- You want to build a Xamarin.Forms application (no matter on which platform)
- You want to build a Xamarin.Forms application (no matter on which platform) using LibVLCSharp.
For other platforms, see the [main documentation](../README.md)
\ No newline at end of file
......@@ -85,22 +85,25 @@ LibVLC is the actual VLC engine written mostly in C/C++ and compiled for your ta
2. Install **LibVLCSharp** _or_ **LibVLCSharp.Forms** (if you plan on using Xamarin.Forms)
| Platform | LibVLCSharp Package | NuGet |
| ----------------- | -------------------------------------------- | ------------------------------------------------- |
| .NET Standard | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Android | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.iOS | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.tvOS | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Mac | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Forms | LibVLCSharp.Forms | [![LibVLCSharpFormsBadge]][LibVLCSharpForms] |
| WPF | LibVLCSharp.WPF | [![LibVLCSharpWPFBadge]][LibVLCSharpWPF] |
| Xamarin.Forms.WPF | LibVLCSharp.Forms.WPF | [![LibVLCSharpFormsWPFBadge]][LibVLCSharpFormsWPF]|
| GTK | [LibVLCSharp.GTK](LibVLCSharp.GTK/README.md) | [![LibVLCSharpGTKBadge]][LibVLCSharpGTK] |
| Xamarin.Forms.GTK | LibVLCSharp.Forms.GTK | [![LibVLCSharpFormsGTKBadge]][LibVLCSharpFormsGTK]|
| Windows Forms | LibVLCSharp.WinForms | [![LibVLCSharpWinFormsBadge]][LibVLCSharpWinForms]|
| Platform | LibVLCSharp Package | NuGet |
| ----------------- | ----------------------------------------------- | ------------------------------------------------- |
| .NET Standard | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Android | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.iOS | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.tvOS | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Mac | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Forms | [LibVLCSharp.Forms](LibVLCSharp.Forms/README.md)| [![LibVLCSharpFormsBadge]][LibVLCSharpForms] |
| WPF | LibVLCSharp.WPF | [![LibVLCSharpWPFBadge]][LibVLCSharpWPF] |
| Xamarin.Forms.WPF | [LibVLCSharp.Forms.WPF][RLibVLCSharpFormsWPF] | [![LibVLCSharpFormsWPFBadge]][LibVLCSharpFormsWPF]|
| GTK | [LibVLCSharp.GTK](LibVLCSharp.GTK/README.md) | [![LibVLCSharpGTKBadge]][LibVLCSharpGTK] |
| Xamarin.Forms.GTK | [LibVLCSharp.Forms.GTK][RLibVLCSharpFormsGTK] | [![LibVLCSharpFormsGTKBadge]][LibVLCSharpFormsGTK]|
| Windows Forms | LibVLCSharp.WinForms | [![LibVLCSharpWinFormsBadge]][LibVLCSharpWinForms]|
LibVLCSharp is the .NET wrapper that consumes `LibVLC` and allows you to interact with native code from C#/F#.
[RLibVLCSharpFormsWPF]: LibVLCSharp.Forms.Platforms.WPF/README.md
[RLibVLCSharpFormsGTK]: LibVLCSharp.Forms.Platforms.GTK/README.md
[LibVLCWindowsBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.Windows.svg
[LibVLCWindows]: https://www.nuget.org/packages/VideoLAN.LibVLC.Windows/
......
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