Update the README
authorJean-Baptiste Kempf <jb@videolan.org>
Wed, 7 Sep 2011 17:59:09 +0000 (19:59 +0200)
committerJean-Baptiste Kempf <jb@videolan.org>
Wed, 7 Sep 2011 17:59:24 +0000 (19:59 +0200)
README

diff --git a/README b/README
index ecf0310..a757582 100644 (file)
--- a/README
+++ b/README
@@ -1,34 +1,58 @@
 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 VideoLAN web site . . . http://www.videolan.org/
-Documentation . . . . . . . http://www.videolan.org/doc/
+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
+Bugtracker  . . . . . . . . http://trac.videolan.org/
 
+Files:
+======
 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.
 NEWS               - Important modifications between the releases.
 README             - This file.
-THANKS             - All VLC contributors.
-bindings/          - Bindings around LibVLC.
+THANKS             - VLC contributors.
+
+Folders:
+========
+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     - external libraries retrieving facilities for systems that
-                     don't have package manager.
-extras/deprecated  - Now deprecated 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/           - Include files
-doc/               - Miscellaneous documentation.
-libs/              - libraries that we host.
+include/           - Include files.
+lib/               - libVLC source code.
+modules/           - VLC plugins and modules. Most of the code is here.
 po/                - languages related files.
 projects/          - projects that uses libVLC such as the web browsers plugin.
 share/             - Common Resources files.
 src/               - VLC and libvlc source code.
+test/              - testing system.