enet/docs/install.dox

64 lines
2.2 KiB
Text
Raw Normal View History

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