X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=400872cfbe64579bd6f5b860c53b59def420715f;hb=5bed700483d854f195151e0b9318ad5a32bba738;hp=5a33d46c2f97958d440cce1f88d90d06fcd3b586;hpb=c788b9a5040a415fbb127251d1dbe3602e4f350e;p=vlc diff --git a/README b/README index 5a33d46c2f..400872cfbe 100644 --- a/README +++ b/README @@ -1,26 +1,56 @@ -$Id$ - README for the VLC media player =============================== +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://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. -FAQ - Commonly asked questions. -HACKING - Hacking vlc. -INSTALL - Installation instructions. -INSTALL.win32 - Installation instructions for the Win32 version of vlc. +INSTALL - Installation and building instructions. +NEWS - Important modifications between the releases. README - This file. -README.MacOSX.rtf - Information specific to the MacOS X port. -THANKS - All VLC contributors. -doc/ - Miscellaneous documentation. - -Resources -========= - -The VideoLAN web site: http://www.videolan.org/ -Documentation and support: http://w.videolan.org/support/ -Forums: http://forum.videolan.org/ -The Developers site: http://developers.videolan.org/vlc/ +THANKS - VLC contributors. +bin/ - VLC binaries. +bindings/ - libVLC bindings to other languages. +compat/ - compatibility library for operating systems missing + essential functionnalities. +contrib/ - external libraries retrieving facilities for systems that + don't have package manager. +doc/ - Miscellaneous documentation. +extras/analyser - Code analyser and editor specific files. +extras/buildsystem - different buildsystems specific files. +extras/contrib/ - old contrib/. +extras/misc - Files that don't fit in the other extras/ categories. +extras/package - VLC packaging specific files such as spec files. +include/ - Header files. +lib/ - libVLC source code. +modules/ - VLC plugins and modules. Most of the code is here. +po/ - VLC translations. +projects/ - projects that uses libVLC +share/ - Common Resources files. +src/ - libvlccore source code. +test/ - testing system.