Unite SSL service providers and SSL profile classes

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

diff --git a/src/modules/extra/README b/src/modules/extra/README
index 4c4beef9d3eb1858011ea15b8036304176864873..b59494df9e0104c46dd1cc9cc0091ff10292114d 100644 (file)
--- a/src/modules/extra/README
+++ b/src/modules/extra/README
@@ -1 +1,16 @@
-This directory stores modules which require external libraries to compile.\rFor example, m_filter_pcre requires the PCRE libraries.\r\rTo compile any of these modules first ensure you have the required dependencies\r(read the online documentation at http://www.inspircd.org/wiki/) and then cp\rthe .cpp file from this directory into the parent directory (src/modules/) and\rre-configure your inspircd with ./configure -update to detect the new module.\r
\ No newline at end of file
+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 https://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.