README 2.98 KB
Newer Older
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
1
README for the VLC media player
2
===============================
Sam Hocevar's avatar
Sam Hocevar committed
3

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
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/
Antoine Cellerier's avatar
Antoine Cellerier committed
19 20 21
Support . . . . . . . . . . http://www.videolan.org/support/
Forums  . . . . . . . . . . http://forum.videolan.org/
Wiki  . . . . . . . . . . . http://wiki.videolan.org/
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
22
The Developers site . . . . http://wiki.videolan.org/Developers_Corner
Rafaël Carré's avatar
Rafaël Carré committed
23
VLC hacking guide . . . . . http://wiki.videolan.org/Hacker_Guide
24 25
Bugtracker  . . . . . . . . http://trac.videolan.org/vlc/
The VideoLAN web site . . . http://www.videolan.org/
Antoine Cellerier's avatar
Antoine Cellerier committed
26

Rafaël Carré's avatar
Rafaël Carré committed
27 28
Source Code Content:
===================
Sam Hocevar's avatar
Sam Hocevar committed
29
ABOUT-NLS          - Notes on the Free Translation Project.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
30
AUTHORS            - VLC authors.
Sam Hocevar's avatar
Sam Hocevar committed
31
COPYING            - The GPL license.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
32
COPYING.LIB        - The LGPL license.
33
INSTALL            - Installation and building instructions.
34
NEWS               - Important modifications between the releases.
Sam Hocevar's avatar
Sam Hocevar committed
35
README             - This file.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
36 37 38 39 40
THANKS             - VLC contributors.

bin/               - VLC binaries.
bindings/          - libVLC bindings to other languages.
compat/            - compatibility library for operating systems missing
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
41 42 43
                     essential functionalities.
contrib/           - Facilities for retrieving external libraries and building
                     them for systems that don't have the right versions.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
44
doc/               - Miscellaneous documentation.
45 46 47 48
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.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
49 50
extras/tools/      - Facilities for retrieving external building tools needed
                     for systems that don't have the right versions.
Rafaël Carré's avatar
Rafaël Carré committed
51
include/           - Header files.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
52 53
lib/               - libVLC source code.
modules/           - VLC plugins and modules. Most of the code is here.
Rafaël Carré's avatar
Rafaël Carré committed
54
po/                - VLC translations.
55
share/             - Common Resources files.
Rafaël Carré's avatar
Rafaël Carré committed
56
src/               - libvlccore source code.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
57
test/              - testing system.
58 59 60 61 62 63

TODOs for Web Interface:
=======================

1. Move all attribute styling to sass from HTML.
2. Write commands for compilation of sass and js files.
64 65
3. Test and correct issues regarding VLM commands.
4. Review how to make sure precompiled code from \vendors goes to \dist while building.