win/README.txt

   1 Building InspIRCd for Windows:\r
   2 \r
   3 Prerequisites:\r
   4         Visual Studio 2015 or newer (https://www.visualstudio.com)\r
   5         CMake 2.8 or newer (https://cmake.org)\r
   6         If building the installer, NSIS (https://nsis.sourceforge.io)\r
   7 \r
   8 Configuring:\r
   9         First copy any extra modules from extras (such as m_mysql) to the modules directory that you want to build.\r
  10 \r
  11         Run CMake to generate build files. This can be done using the CMake GUI by setting the source code path to "win",\r
  12         and the binary path to "win/build", followed by pressing "Configure". Modify any variables you need, such as install\r
  13         prefix, and then press "Generate".\r
  14         \r
  15         Alternatively CMake can be run from Command Prompt from the "win\build" directory, eg:\r
  16         \r
  17         c:\Users\Adam\Desktop\inspircd\win\build>cmake -G "Visual Studio 11" ..\r
  18         -- Check for working CXX compiler using: Visual Studio 11\r
  19         -- Check for working CXX compiler using: Visual Studio 11 -- works\r
  20         -- Detecting CXX compiler ABI info\r
  21         -- Detecting CXX compiler ABI info - done\r
  22         -- Configuring done\r
  23         -- Generating done\r
  24         -- Build files have been written to: C:/Users/Adam/Desktop/inspircd/win/build\r
  25 \r
  26         This generates project files for Visual Studio 11 (2012). Available generators can be seen in cmake --help,\r
  27         such as Visual Studio 10 and NMake Makefiles.\r
  28         \r
  29         If some of the modules you are building require libraries that are not in the default system path\r
  30         (and thus not found by CMake), you can inform CMake about them by defining EXTRA_INCLUDES and\r
  31         EXTRA_LIBS when configuring, eg;\r
  32         \r
  33         cmake -DEXTRA_INCLUDES:STRING="C:\inspircd-includes" -DEXTRA_LIBS:STRING="C:\inspircd-libs" -G "Visual Studio 11" ..\r
  34         \r
  35         See the CMake GUI for a full list of variables that can be set.\r
  36         \r
  37         Additionally, place any DLL files required by any extra modules in to the win directory for the installer to pick up.\r
  38 \r
  39 Building:\r
  40         Open the InspIRCd Microsoft Visual Studio Solution file. If you are building a release, be sure to change\r
  41         the Solution Configuration to Release before starting the build. Start the build by right clicking the\r
  42         InspIRCd solution in the solution explorer and clicking "Build Solution"\r
  43         \r
  44         If you are building using NMake Makefiles, simply use "nmake".\r
  45 \r
  46 Installing:\r
  47         If you do not want to build the installer you can simply build the INSTALL target, which will probably install\r
  48         InspIRCd into C:\Program Files\InspIRCd. This may require administrative privileges by Visual Studio.\r
  49         \r
  50         If you are building using NMake Makefiles, simply use "nmake install".\r
  51         \r
  52 Building the installer:\r
  53         Locate the PACKAGE project on Visual Studio's Solution Explorer and build it. This will generate an InspIRCd-x.x.x.exe\r
  54         installer in the build directory which is ready to be distributed.\r
  55         \r
  56         If you are building using NMake Makefiles or do not want to build the installer in Visual Studio, simply use "cpack".\r