added note about #include <enet/enet.h>

This commit is contained in:
eihrul 2009-03-16 16:29:05 +00:00
parent 5f50ac3c75
commit 7851c6305b

View file

@ -17,11 +17,17 @@
@section Initialization Initialization @section Initialization Initialization
You should include the file <enet/enet.h> when using ENet. Do not
include <enet.h> without the directory prefix, as this may cause
file name conflicts on some systems.
Before using ENet, you must call enet_initialize() to initialize the Before using ENet, you must call enet_initialize() to initialize the
library. Upon program exit, you should call enet_deinitialize() so library. Upon program exit, you should call enet_deinitialize() so
that the library may clean up any used resources. that the library may clean up any used resources.
@code @code
#include <enet/enet.h>
int int
main (int argc, char ** argv) main (int argc, char ** argv)
{ {