Update the README
[vlc/vlc-test.git] / README
1 README for the VLC media player
2 ===============================
3
4 VLC is a popular libre and open source media player and multimedia engine,
5 used by a large number of individuals, professionals, companies and
6 institutions. Using open source technologies and libraries, VLC has been
7 ported to most computing platforms, including GNU/Linux, Windows, Mac OS X,
8 BSD, iOS and Android.
9 VLC can play most multimedia files, discs, streams, allows playback from
10 devices, and is able to convert to or stream in various formats.
11 The VideoLAN project was started at the university Ă‰cole Centrale Paris who
12 relicensed VLC under the GPLv2 license in February 2001. Since then, VLC has
13 been downloaded close to one billion times.
14
15 Links:
16 ======
17
18 The VideoLAN web site . . . http://www.videolan.org/
19 The VLC web site  . . . . . http://www.videolan.org/
20 Support . . . . . . . . . . http://www.videolan.org/support/
21 Forums  . . . . . . . . . . http://forum.videolan.org/
22 Wiki  . . . . . . . . . . . http://wiki.videolan.org/
23 The Developers site . . . . http://wiki.videolan.org/Developers_Corner
24 Bugtracker  . . . . . . . . http://trac.videolan.org/
25
26 Files:
27 ======
28 ABOUT-NLS          - Notes on the Free Translation Project.
29 AUTHORS            - VLC authors.
30 COPYING            - The GPL license.
31 HACKING            - Hacking VLC.
32 INSTALL            - Installation instructions.
33 NEWS               - Important modifications between the releases.
34 README             - This file.
35 THANKS             - VLC contributors.
36
37 Folders:
38 ========
39 bin/               - VLC binaries.
40 bindings/          - libVLC bindings to other languages.
41 compat/            - compatibility library for operating systems missing
42                      essential functionnalities.
43 contrib/           - external libraries retrieving facilities for systems that
44                      don't have package manager.
45 doc/               - Miscellaneous documentation.
46 extras/analyser    - Code analyser and editor specific files.
47 extras/buildsystem - different buildsystems specific files.
48 extras/contrib/    - old contrib/.
49 extras/misc        - Files that don't fit in the other extras/ categories.
50 extras/package     - VLC packaging specific files such as spec files.
51 include/           - Include files.
52 lib/               - libVLC source code.
53 modules/           - VLC plugins and modules. Most of the code is here.
54 po/                - languages related files.
55 projects/          - projects that uses libVLC such as the web browsers plugin.
56 share/             - Common Resources files.
57 src/               - VLC and libvlc source code.
58 test/              - testing system.