X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=22222ea167c7c40ed18c363c0f600bb863a55af3;hb=a6a9069447c055b25720e65ee650ba5277b03213;hp=394e9511eada39f54b6dd6176c1efc280ed41b87;hpb=4ee6361f0dca1c334bd25956fdd3a07e12ced09a;p=vlc diff --git a/README b/README index 394e9511ea..22222ea167 100644 --- a/README +++ b/README @@ -1,34 +1,57 @@ README for the VLC media player =============================== -The VideoLAN web site . . . http://www.videolan.org/ -Documentation . . . . . . . http://www.videolan.org/doc/ +VLC is a popular libre and open source media player and multimedia engine, +used by a large number of individuals, professionals, companies and +institutions. Using open source technologies and libraries, VLC has been +ported to most computing platforms, including GNU/Linux, Windows, Mac OS X, +BSD, iOS and Android. +VLC can play most multimedia files, discs, streams, allows playback from +devices, and is able to convert to or stream in various formats. +The VideoLAN project was started at the university École Centrale Paris who +relicensed VLC under the GPLv2 license in February 2001. Since then, VLC has +been downloaded close to one billion times. + +Links: +====== + +The VLC web site . . . . . http://www.videolan.org/ Support . . . . . . . . . . http://www.videolan.org/support/ Forums . . . . . . . . . . http://forum.videolan.org/ Wiki . . . . . . . . . . . http://wiki.videolan.org/ -The Developers site . . . . http://www.videolan.org/developers/vlc.html +The Developers site . . . . http://wiki.videolan.org/Developers_Corner +VLC hacking guide . . . . . http://wiki.videolan.org/Hacker_Guide +Bugtracker . . . . . . . . http://trac.videolan.org/vlc/ +The VideoLAN web site . . . http://www.videolan.org/ +Source Code Content: +=================== ABOUT-NLS - Notes on the Free Translation Project. -AUTHORS - Main VLC authors. +AUTHORS - VLC authors. COPYING - The GPL license. -ChangeLog - The vlc ChangeLog. -HACKING - Hacking vlc. -INSTALL - Installation instructions. -INSTALL.win32 - Installation instructions for the Win32 version of vlc. +COPYING.LIB - The LGPL license. +INSTALL - Installation and building instructions. +NEWS - Important modifications between the releases. README - This file. -THANKS - All VLC contributors. -bindings/ - Bindings around LibVLC. +THANKS - VLC contributors. + +bin/ - VLC binaries. +bindings/ - libVLC bindings to other languages. +compat/ - compatibility library for operating systems missing + essential functionalities. +contrib/ - Facilities for retrieving external libraries and building + them for systems that don't have the right versions. +doc/ - Miscellaneous documentation. extras/analyser - Code analyser and editor specific files. extras/buildsystem - different buildsystems specific files. -extras/contrib - external libraries retrieving facilities for systems that - don't have package manager. -extras/deprecated - Now deprecated files. extras/misc - Files that don't fit in the other extras/ categories. extras/package - VLC packaging specific files such as spec files. -include/ - Include files -doc/ - Miscellaneous documentation. -libs/ - libraries that we host. -po/ - languages related files. -projects/ - projects that uses libvlc such as the web browsers plugin. +extras/tools/ - Facilities for retrieving external building tools needed + for systems that don't have the right versions. +include/ - Header files. +lib/ - libVLC source code. +modules/ - VLC plugins and modules. Most of the code is here. +po/ - VLC translations. share/ - Common Resources files. -src/ - VLC and LibVLC source code. +src/ - libvlccore source code. +test/ - testing system.