X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=22222ea167c7c40ed18c363c0f600bb863a55af3;hb=857663915d77dccb1c262fbe46b5ce8b892552e8;hp=40eb587915441d849d74b644f8b8bf94a56dbda5;hpb=88dee5fd2df4fd53a08fe188b1c8623651797298;p=vlc diff --git a/README b/README index 40eb587915..22222ea167 100644 --- a/README +++ b/README @@ -1,26 +1,57 @@ -$Id: README,v 1.12 2002/11/26 14:08:01 sam Exp $ +README for the VLC media player +=============================== -README for vlc, the VideoLAN Client -=================================== +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 - All the people who worked on vlc. -BUGS - List of known, unresolved bugs. +AUTHORS - VLC authors. COPYING - The GPL license. -ChangeLog - The vlc ChangeLog. -FAQ - Commonly asked questions. -HACKING - Hacking vlc. -INSTALL - Installation instructions. -INSTALL.libmad - Installation instructions for the libmad library. -INSTALL.win32 - Installation instructions for the Win32 version of vlc. -MODULES - Short description of all the available modules. +COPYING.LIB - The LGPL license. +INSTALL - Installation and building instructions. +NEWS - Important modifications between the releases. README - This file. -README.MacOSX.rtf - Information specific to the MacOS X port. -doc/ - miscellaneous documentation. - -Resources -========= - -The VideoLAN web site : http://www.videolan.org/ -Mailing-lists : http://www.videolan.org/lists.html +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/misc - Files that don't fit in the other extras/ categories. +extras/package - VLC packaging specific files such as spec files. +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/ - libvlccore source code. +test/ - testing system.