install.dox 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. /**
  2. @page Installation Installation
  3. ENet should be trivially simple to integrate with most applications.
  4. First, make sure you download the latest source distribution at @ref Downloads.
  5. @section Unix Unix-like Operating Systems
  6. If you are using an ENet release, then you should simply be able to build it
  7. by doing the following:
  8. ./configure && make && make install
  9. If you obtained the package from github, you must have automake and autoconf
  10. available to generate the build system first by doing the following command
  11. before using the above mentioned build procedure:
  12. autoreconf -vfi
  13. @subsection SolarisBSD Solaris and BSD
  14. When building ENet under Solaris, you must specify the -lsocket and
  15. -lnsl parameters to your compiler to ensure that the sockets library
  16. is linked in.
  17. @section Windows Microsoft Windows
  18. You may simply use the included "enet.lib" or "enet64.lib" static libraries.
  19. However, if you wish to build the library yourself, then the following
  20. instructions apply:
  21. There is an included MSVC 6 project (enet.dsp) which you may use to
  22. build a suitable library file. Alternatively, you may simply drag all
  23. the ENet source files into your main project.
  24. You will have to link to the Winsock2 libraries, so make sure to add
  25. ws2_32.lib and winmm.lib to your library list (Project Settings | Link |
  26. Object/library modules).
  27. @subsection enet.dsp Building with the included enet.dsp
  28. Load the included enet.dsp. MSVC may ask you to convert it if you
  29. are on a newer version of MSVC - just allow the conversion and save
  30. the resulting project as "enet" or similar. After you build this
  31. project, it will output an "enet.lib" file to either the "Debug/"
  32. or "Release/" directory, depending on which configuration you have
  33. selected to build. By default, it should produce "Debug/enet.lib".
  34. You may then copy the resulting "enet.lib" file and the header files
  35. found in the "include/" directory to your other projects and add it to
  36. their library lists. Make sure to also link against "ws2_32.lib" and
  37. "winmm.lib" as described above.
  38. @subsection DLL DLL
  39. If you wish to build ENet as a DLL you must first define ENET_DLL
  40. within the project (Project Settings | C/C++ | Preprocessor |
  41. Preprocessor definitions) or, more invasively, simply define ENET_DLL
  42. at the top of enet.h.
  43. */