Commit 608fb383 authored by Martin Finkel's avatar Martin Finkel

doc: Improve LibVLCSharp.GTK README

parent e2bbf835
......@@ -3,14 +3,14 @@
[![NuGet Stats](https://img.shields.io/nuget/v/LibVLCSharp.GTK.svg)](https://www.nuget.org/packages/LibVLCSharp.GTK)
[![NuGet Stats](https://img.shields.io/nuget/dt/LibVLCSharp.GTK.svg)](https://www.nuget.org/packages/LibVLCSharp.GTK)
The official [GTK#](https://github.com/mono/gtk-sharp) views for [LibVLCSharp](../LibVLCSharp).
The official [GTK#](https://github.com/mono/gtk-sharp) views for [LibVLCSharp](../LibVLCSharp/README.md).
This package contains the views that allows to display a video played with [LibVLCSharp](../LibVLCSharp)
This package contains the views that allows to display a video played with [LibVLCSharp](../LibVLCSharp/README.md)
in a GTK# app (the mono/gtk-sharp one, [see below](#note-on-gtk-sharp)).
[LibVLCSharp.Forms.Platforms.GTK](../LibVLCSharp.Forms.Platforms.GTK) depends on this package.
This package depends on [LibVLCSharp](../LibVLCSharp).
This package depends on [LibVLCSharp](../LibVLCSharp/README.md).
Supported frameworks:
......@@ -21,29 +21,26 @@ Supported platforms:
- Windows
- Linux
NOTE: This package does not currently support MacOSX! See [this issue](https://code.videolan.org/videolan/LibVLCSharp/issues/92)
NOTE: This package does not currently support macOS! See [this issue](https://code.videolan.org/videolan/LibVLCSharp/issues/92)
WARNING : To create a GTK# program and run the samples, you will need mono and GTK# installed on the machine you build AND
WARNING: To create a GTK# program and run the samples, you will need mono and GTK# installed on the machine you build AND
on the machine you run.
## <a name="note-on-gtk-sharp"></a> A note on mono/gtk-sharp vs GtkSharp/GtkSharp
Let's face it, mono/gtk-sharp has a lot of drawbacks :
Let's face it, mono/gtk-sharp has a lot of drawbacks:
- It is based on GTK 2 (GTK 3 was released in 2011... but no stable version of GTK# for GTK3 as of now)
- Requires mono and GTK# installed on both the build and the target machine. (aka no nuget package)
Well, to be honest, that's only two, but that's two big drawbacks.
On the other hand, [GtkSharp/GtkSharp](https://github.com/GtkSharp/GtkSharp) fixes this issues by providing a
.net standard 2.0 package for GTK 3.0
and NuGet packages for the GTK# libraries.
.NET Standard 2.0 package for GTK 3.0 and NuGet packages for the GTK# libraries.
Unfortunately, Xamarin.Forms.GTK is only implemented using the former, which means that in order to support Xamarin.Forms.GTK, our views needs to support mono/gtk-sharp, hence this package.
## Why should I reference this package in my project?
If you you want to create a cross-platform video application using GTK#, this package is made for you.
If you want to create a video application using GTK# and C# with mono, this package is made for you.
You can also create a true cross-platform application with Xamarin.Forms, and use the GTK# backend to target linux and windows.
In that case, you would need the [LibVLCSharp.Forms.Platforms.GTK](../LibVLCSharp.Forms.Platforms.GTK) package instead,
......
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