Compile fix

[vlc] / HACKING

diff --git a/HACKING b/HACKING
index e5317f57a6d251e731a1aa5f62893443620961b4..3a0203bc4ae6c4e4750d1c13842227571719f581 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,25 +1,34 @@
-$Id: HACKING,v 1.8 2003/06/27 13:50:07 sam Exp $
+$Id$
 
 Hacking vlc
 ===========
 
-Requirements
-------------
+First
+-----
+
+ - Read this file
 
-You will need the following tools if you plan to use the CVS version of vlc:
+ - Read the information present on http://www.videolan.org/developers/
 
- - autoconf version 2.50 or later
 
- - automake version 1.5 (but 1.6 or later is recommended)
+Requirements
+____________
+
+You will need the following tools if you plan to use the SVN version of vlc:
 
- - gettext version 0.10.40 (but 0.11.3 or later is recommended)
+ - Autoconf version 2.60 or later
+ - Automake version 1.9 or later
+ - gettext version 0.16.1 or later
+ - pkg-config
+ - libgcrypt 1.2 (or compatible)
 
-After retrieving the CVS tree, you need to run the bootstrap script to
+After retrieving the SVN 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 CVS tree on an OS that provides these tools (such
+you can check out a SVN 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.
 
@@ -63,6 +72,17 @@ How to add a module
 -------------------
 
 To add a module to the repository, just add its sources to a Modules.am
-file. If you create a new Modules.am, do not forget to add a corresponding
-line to modules/Makefile.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_PLUGINS or
+VLC_ADD_BUILTINS 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 module (in ~/.vlc/cache 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.