Merge pull request #92 from Robby-/insp20-headers

[user/henk/code/inspircd.git] / src / modules / extra / README

diff --git a/src/modules/extra/README b/src/modules/extra/README
index 7e3096b34e5a7dec055966b54acde53c7e0cf7f0..2478b57cf49e34b7f9dc23ab99c2dff9fd93d490 100644 (file)
--- a/src/modules/extra/README
+++ b/src/modules/extra/README
@@ -2,6 +2,15 @@ This directory stores modules which require external libraries to compile.
 For example, m_filter_pcre requires the PCRE libraries.
 
 To compile any of these modules first ensure you have the required dependencies
-(read the online documentation at http://www.inspircd.org/wiki/) and then cp
-the .cpp file from this directory into the parent directory (src/modules/) and
-re-configure your inspircd with ./configure -update to detect the new module.
+(read the online documentation at http://wiki.inspircd.org/) and then symlink
+the .cpp file from this directory into the parent directory (src/modules/).
+
+Alternatively, use the command: ./configure --enable-extras=m_extra.cpp, which will
+automatically take care of symlinking the module of that name and any headers it needs
+from the extras directory. You can also use ./configure --list-extras to see what
+modules are available, and whether they are enabled or not. You still are responsible
+for resolving any external dependencies however (ie, PCRE, MySQL, GnuTLS, etc).
+
+NOTE: Some modules require you to copy other dependencies too, such as a related header.
+If you get missing header errors when building these modules, check that the header is
+not within modules/extra before checking for external dependencies.