summaryrefslogtreecommitdiff
path: root/src/modules/extra/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/extra/README')
-rw-r--r--src/modules/extra/README7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/modules/extra/README b/src/modules/extra/README
new file mode 100644
index 000000000..7e3096b34
--- /dev/null
+++ b/src/modules/extra/README
@@ -0,0 +1,7 @@
+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.