Commit d0b5d50d authored by Jérémy VIGNELLES's avatar Jérémy VIGNELLES Committed by Martin Finkel

Add tables

by @mfkl

(cherry picked from commit bdd30ece4f96f37a83dd59729c60f9f0b3282763)
parent d8d0a54b
......@@ -16,7 +16,7 @@ Supported frameworks:
- net47 (on mono)
Supported platforms :
Supported platforms:
- Windows
- Linux
......@@ -33,7 +33,7 @@ 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 honnest, that's only two, but that's two big drawbacks.
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
......
......@@ -5,7 +5,7 @@
The official .NET wrapper around LibVLC.
This package contains the core features of LibVLCSharp (libvlc loading and initialization, .net-friendly classes to ease the use of libvlc...).
This package contains the core features of LibVLCSharp (libvlc loading and initialization, .NET-friendly classes to ease the use of libvlc...).
All other `LibVLCSharp.*` packages depend on this one.
This package also contains the views for the following platforms:
......@@ -17,7 +17,7 @@ This package also contains the views for the following 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!
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?
......@@ -25,6 +25,6 @@ This package has multiple target frameworks, which means it will pick the right
If you are in one of these situation, this package is made for you.
- You want to build a console application that leverages the power of VLC for transcoding/streaming/recording/playing audio... without displaying the video anywhere
- You want to build a Xamarin.iOS/Android/Mac/tvOS (not Xamarin.Forms, for that, see [LibVLCSharp.Forms](../LibVLCSharp.Forms) )
- You want to build a Xamarin.iOS/Android/Mac/tvOS (not Xamarin.Forms, for that, see [LibVLCSharp.Forms](../LibVLCSharp.Forms/README.md) )
For other platforms, see the [main documentation](../README.md)
\ No newline at end of file
......@@ -12,22 +12,24 @@ It provides a comprehensive multimedia API that can be used across mobile, serve
_The official repository URL for this repo is https://code.videolan.org/videolan/LibVLCSharp._
- [Features](#features)
- [Supported platforms](#supported-platforms)
- [Installation](#installation)
- [Getting started](#getting-started)
- [Samples](#samples)
- [Quick API overview](#quick-api-overview)
- [Roadmap](#roadmap)
- [Versioning](VERSIONING.md)
- [Contribute](#contribute)
- [Communication](#communication)
- [Forum](#forum)
- [GitLab Issues](#issues)
- [IRC](#irc)
- [StackOverflow](#stackoverflow)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
- [LibVLCSharp](#libvlcsharp)
- [Features](#features)
- [Supported platforms](#supported-platforms)
- [Installation](#installation)
- [Getting started](#getting-started)
- [Samples](#samples)
- [Quick API overview](#quick-api-overview)
- [Roadmap](#roadmap)
- [Contribute](#contribute)
- [Pull request](#pull-request)
- [Gitlab issues](#gitlab-issues)
- [Communication](#communication)
- [Forum](#forum)
- [Issues](#issues)
- [IRC](#irc)
- [StackOverflow](#stackoverflow)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Features
......@@ -63,7 +65,16 @@ Mono, .NET Framework and .NET Core runtimes are supported.
## Installation
1. Install LibVLC in your platform specific project.
1. Install **LibVLC** in your platform specific project.
| Platform | LibVLC Package | NuGet |
| ----------------- | ----------------------------------- | -------------------------------------- |
| Windows | VideoLAN.LibVLC.Windows | [![LibVLCWindowsBadge]][LibVLCWindows] |
| Mac | VideoLAN.LibVLC.Mac | [![LibVLCMacBadge]][LibVLCMac] |
| Android | VideoLAN.LibVLC.Android | [![LibVLCAndroidBadge]][LibVLCAndroid] |
| iOS | VideoLAN.LibVLC.iOS | [![LibVLCiOSBadge]][LibVLCiOS] |
| tvOS | VideoLAN.LibVLC.tvOS | [![LibVLCtvOSBadge]][LibVLCtvOS] |
| Linux | [Linux guide](docs/linux-setup.md) | N/A |
```cmd
dotnet add package VideoLAN.LibVLC.[Windows|Android|iOS|Mac|tvOS]
......@@ -71,9 +82,24 @@ dotnet add package VideoLAN.LibVLC.[Windows|Android|iOS|Mac|tvOS]
LibVLC is the actual VLC engine written mostly in C/C++ and compiled for your target platform. More information [here](https://code.videolan.org/videolan/libvlc-nuget).
2. Install LibVLCSharp _or_ LibVLCSharp.Forms (if you plan on using Xamarin.Forms)
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]|
LibVLCSharp is the .NET wrapper that consumes `LibVLC` and allows you to interact with native code from C#/F#.
LibVLCSharp is the .NET wrapper that consumes `LibVLC` and allows you to interact with native code from C#/F#.
```cmd
dotnet add package LibVLCSharp
......@@ -120,6 +146,46 @@ If you're using __GTK__ (with or without Xamarin.Forms support) on Linux and/or
dotnet add package LibVLCSharp.GTK
```
[LibVLCWindowsBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.Windows.svg
[LibVLCWindows]: https://www.nuget.org/packages/VideoLAN.LibVLC.Windows/
[LibVLCMac]: https://www.nuget.org/packages/VideoLAN.LibVLC.Mac/
[LibVLCMacBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.Mac.svg
[LibVLCAndroid]: https://www.nuget.org/packages/VideoLAN.LibVLC.Android/
[LibVLCAndroidBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.Android.svg
[LibVLCiOS]: https://www.nuget.org/packages/VideoLAN.LibVLC.iOS/
[LibVLCiOSBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.iOS.svg
[LibVLCtvOS]: https://www.nuget.org/packages/VideoLAN.LibVLC.tvOS/
[LibVLCtvOSBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.tvOS.svg
[LibVLCSharp]: https://www.nuget.org/packages/LibVLCSharp/
[LibVLCSharpBadge]: https://img.shields.io/nuget/v/LibVLCSharp.svg
[LibVLCSharpForms]: https://www.nuget.org/packages/LibVLCSharp.Forms/
[LibVLCSharpFormsBadge]: https://img.shields.io/nuget/v/LibVLCSharp.Forms.svg
[LibVLCSharpWPF]: https://www.nuget.org/packages/LibVLCSharp.WPF/
[LibVLCSharpWPFBadge]: https://img.shields.io/nuget/v/LibVLCSharp.WPF.svg
[LibVLCSharpFormsWPF]: https://www.nuget.org/packages/LibVLCSharp.Forms.WPF/
[LibVLCSharpFormsWPFBadge]: https://img.shields.io/nuget/v/LibVLCSharp.Forms.WPF.svg
[LibVLCSharpGTK]: https://www.nuget.org/packages/LibVLCSharp.GTK/
[LibVLCSharpGTKBadge]: https://img.shields.io/nuget/v/LibVLCSharp.GTK.svg
[LibVLCSharpFormsGTK]: https://www.nuget.org/packages/LibVLCSharp.Forms.GTK/
[LibVLCSharpFormsGTKBadge]: https://img.shields.io/nuget/v/LibVLCSharp.Forms.GTK.svg
[LibVLCSharpWinForms]: https://www.nuget.org/packages/LibVLCSharp.WinForms/
[LibVLCSharpWinFormsBadge]: https://img.shields.io/nuget/v/LibVLCSharp.WinForms.svg
## Getting started
Feel free to check out the simple sample projects for [iOS](https://github.com/videolan/libvlcsharp/tree/master/Samples/LibVLCSharp.iOS.Sample) and [Android](https://github.com/videolan/libvlcsharp/tree/master/Samples/LibVLCSharp.Android.Sample) to get started.
......
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