X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fextra%2FREADME;h=4f97075eaca5c41393164bada71d3d4a7c245e9a;hb=3151d60c1ecc9462e4c335282ee6c31672f45111;hp=7e3096b34e5a7dec055966b54acde53c7e0cf7f0;hpb=61f2deb53d706c7791724093034f1bdc0a337673;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/extra/README b/src/modules/extra/README index 7e3096b34..4f97075ea 100644 --- a/src/modules/extra/README +++ b/src/modules/extra/README @@ -1,7 +1,16 @@ This directory stores modules which require external libraries to compile. -For example, m_filter_pcre requires the PCRE libraries. +For example, m_regex_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 https://docs.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.