aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authoreihrul <eihrul>2009-03-16 16:29:05 +0000
committereihrul <eihrul>2009-03-16 16:29:05 +0000
commit7851c6305b2e90cf0083ffa01eaa9cabf311a2e1 (patch)
treecd2d2d7214bbd1934eaf4c0ea0b0719ee342ee1c /docs
parent5f50ac3c75c0487d4a1e5c2dfce4af999ec7cc82 (diff)
downloadenet-7851c6305b2e90cf0083ffa01eaa9cabf311a2e1.tar.gz
enet-7851c6305b2e90cf0083ffa01eaa9cabf311a2e1.zip
added note about #include <enet/enet.h>
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/tutorial.dox6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/tutorial.dox b/docs/tutorial.dox
index 7829d6c..62e615f 100755
--- a/docs/tutorial.dox
+++ b/docs/tutorial.dox
@@ -17,11 +17,17 @@
@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
library. Upon program exit, you should call enet_deinitialize() so
that the library may clean up any used resources.
@code
+#include <enet/enet.h>
+
int
main (int argc, char ** argv)
{