Commit 6ea238b6 authored by Alexandre Janniaux's avatar Alexandre Janniaux Committed by Jean-Baptiste Kempf
Browse files

doc: add main page for documentation



Small main page for describing the content of the documentation, while
splitting and describing the role of both libVLC and libvlccore.

It is ought to be extended later.

Co-authored-by: default avatarSimon Latapie <garf@videolabs.io>
parent 410fef4d
\mainpage
# LibVLC and libvlccore documentation
## Introduction
[libVLC](@ref libvlc_documentation) is an embeddable engine for
3rd party applications and frameworks.
It runs on the same platforms as VLC <em>(and sometimes on more)</em>
and can provide playback, streaming and conversion of multimedia
files and streams.
[libVLC](@ref libvlc_documentation) has numerous bindings for
other languages, such as C++, Python, java, Objective-C and C#.
## License
[libVLC](@ref libvlc_documentation) and **libvlccore** are released
under the LGPLv2 <em>(or later)</em> license. This allows embedding the
engine in 3rd party applications, while letting them to be licensed
under other licenses.
However, note that some plugins are under more restrictive licenses,
such as GPLv3 <em>(or later)</em>.
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