Skip to content
Snippets Groups Projects

docs: add initial doc file

Merged Martin Finkel requested to merge mfkl/vlc-unity:docs into master
docs/home.md 0 → 100644
+ 25
0
# VLC for Unity documentation
- [User documentation](#user-documentation)
- [Make a release](#make-a-release)
- [Platform support](#platform-spport)
## User documentation
Given that VLC for Unity is based on LibVLCSharp, it shares 99% of the same APIs which means the LibVLCSharp documentation applies. You can find it [here](https://code.videolan.org/videolan/LibVLCSharp/-/blob/3.x/docs/home.md).
A basic explanation of the demo scenes provided in the asset is detailed in the [documentation text file](..\Assets\VLCUnity\documentation.txt).
## Make a release
This is a list of things to check until the release is more automated. Though the "uploading to the store" step cannot be scripted currently.
- plugins.dat generation,
- avoid js files,
- trial ftp upload,
- check that editor and standalone demo scenes work,
- check final package size size (~50MB),
## Platform support
Currently only Windows classic (win64) is supported (not UWP).
\ No newline at end of file
Loading