+++ /dev/null
-Hacking vlc
-===========
-
-First
------
-
- - Read this file
-
- - Read the information present on http://www.videolan.org/developers/
-
-
-Requirements
-____________
-
-You will need the following tools if you plan to use the GIT version of vlc:
-
- - Autoconf version 2.60 or later
- - Automake version 1.9 or later
- - gettext version 0.16.1 or later
- - pkg-config
-
-After retrieving the GIT tree, you need to run the bootstrap script to
-generate all the files needed to build vlc. You can then run configure.
-Run ./configure --help for a description of the available options.
-
-If you do not have the correct version of these tools, or if they are
-simply not available for the operating system you plan to develop on,
-you can check out a GIT tree on an OS that provides these tools (such
-as a recent Linux distribution), run bootstrap, and then copy the whole
-tree to your retarded OS.
-
-There is a possibility that, at some point, automake might segfault. The
-reason is unsufficient stack size, and can be easily fixed with the
-`ulimit` command (or an equivalent) available in most shells. For instance
-on bash 2.0, the following command solves the automake crash on Mac OS X :
-ulimit -s 20000
-
-
-The bootstrap sequence
-----------------------
-
-The bootstrap script does the following actions:
-
- - parse configure.ac for all Makefiles in the modules/ directory that need
- to be generated, and look for available modules in the corresponding
- Modules.am file. A module "foo" exists if there is a Modules.am file in
- the modules/ directory which defines SOURCES_foo.
-
- - create an m4/private.m4 from configure.ac, generating m4 macros that will
- be needed by configure.ac.
-
- - create a Makefile.am file for each Modules.am file found in modules/ .
-
- - run autopoint (previously gettextize) to provide build system support
- for internationalization.
-
- - run the usual aclocal, autoheader, automake and autoconf, which create
- the various Makefile.in files from the corresponding Makefile.am and the
- configure script from configure.ac.
-
- - fix a few files in the vlc repository that may have been altered.
-
-
-How to add a module
--------------------
-
-To add a module to the repository, just add its sources to a Modules.am
-file. If you add a new directory you will need to create a new Modules.am,
-inside that directory. Do not forget to add a corresponding
-Makefile line at the end of configure.ac for this new Modules.am file.
-
-To have the module built, you need to add a call to VLC_ADD_PLUGIN to
-configure.ac with your new module name as argument.
-Look at other modules for guidelines on how to add build and linkage options.
-
-After changing configure.ac you will always need to rerun bootstrap and
-configure.
-
-VLC keeps a cache of its modules (in ~/.cache/vlc/ on Linux), so you'll have to
-delete it (or use vlc --reset-plugins-cache). Then use vlc -vvv --color --list
-to check that your plugin is seen by VLC.
-
INSTALL file for the VLC media player
+=====================================
More extensive information for *nix, Windows and Mac OS X users can be
-found here: http://developers.videolan.org/vlc/
+found here: http://wiki.videolan.org/Compile_VLC
+
+People installing VLC for Windows from source MUST read:
+http://wiki.videolan.org/Win32Compile
Bootstrapping VLC
=================
-If you retrieved VLC from the git server and do not have a "configure"
-script, please refer to the HACKING file.
+If you retrieved VLC from the git server and do not have yet a "configure"
+script, please run:
+
+ ./bootstrap
Configuring VLC
===============
Links:
======
-The VideoLAN web site . . . http://www.videolan.org/
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
-Bugtracker . . . . . . . . http://trac.videolan.org/
+VLC hacking guide . . . . . http://wiki.videolan.org/Documentation:Hacker%27s_Guide
+Bugtracker . . . . . . . . http://trac.videolan.org/vlc/
+The VideoLAN web site . . . http://www.videolan.org/
Files:
======
ABOUT-NLS - Notes on the Free Translation Project.
AUTHORS - VLC authors.
COPYING - The GPL license.
-HACKING - Hacking VLC.
-INSTALL - Installation instructions.
+INSTALL - Installation and building instructions.
NEWS - Important modifications between the releases.
README - This file.
THANKS - VLC contributors.