| 1 | /** @mainpage enet |
|---|
| 2 | <center>http://enet.bespin.org</center> |
|---|
| 3 | <hr> |
|---|
| 4 | |
|---|
| 5 | ENet's purpose is to provide a relatively thin, simple and robust |
|---|
| 6 | network communication layer on top of UDP (User Datagram Protocol). |
|---|
| 7 | The primary feature it provides is optional reliable, in-order |
|---|
| 8 | delivery of packets. |
|---|
| 9 | |
|---|
| 10 | ENet omits certain higher level networking features such as authentication, |
|---|
| 11 | lobbying, server discovery, encryption, or other similar tasks that are |
|---|
| 12 | particularly application specific so that the library remains flexible, |
|---|
| 13 | portable, and easily embeddable. |
|---|
| 14 | |
|---|
| 15 | @ref Features |
|---|
| 16 | |
|---|
| 17 | @ref SourceDistro |
|---|
| 18 | |
|---|
| 19 | @ref Installation |
|---|
| 20 | |
|---|
| 21 | @ref Tutorial |
|---|
| 22 | |
|---|
| 23 | @ref MailingList |
|---|
| 24 | |
|---|
| 25 | @ref IRCChannel |
|---|
| 26 | |
|---|
| 27 | @ref FAQ |
|---|
| 28 | |
|---|
| 29 | @ref License |
|---|
| 30 | |
|---|
| 31 | */ |
|---|
| 32 | |
|---|
| 33 | /** |
|---|
| 34 | @page SourceDistro Source Distribution |
|---|
| 35 | |
|---|
| 36 | You can retrieve the source to ENet by downloading it in either .tar.gz form |
|---|
| 37 | or accessing the cvs distribution directly. |
|---|
| 38 | |
|---|
| 39 | The most recent stable release (1.3.0) can be downloaded <a href="http://enet.bespin.org/download/enet-1.3.0.tar.gz">here</a>. |
|---|
| 40 | The last release that is protocol compatible with the 1.2 series or earlier (1.2.2) can be downloaded <a href="http://enet.bespin.org/download/enet-1.2.2.tar.gz">here</a> |
|---|
| 41 | |
|---|
| 42 | To access ENet via anonymous CVS, you must use the CVSROOT |
|---|
| 43 | :pserver:anonymous\@bespin.org:/var/lib/cvs/enet with an empty |
|---|
| 44 | password. |
|---|
| 45 | |
|---|
| 46 | @code |
|---|
| 47 | $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet login |
|---|
| 48 | @endcode |
|---|
| 49 | Hit the return key when prompted for a password. |
|---|
| 50 | @code |
|---|
| 51 | $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet co -l . |
|---|
| 52 | $ cvs -z3 co enet |
|---|
| 53 | @endcode |
|---|
| 54 | |
|---|
| 55 | This will create a CVS directory in the current directory, and with |
|---|
| 56 | the second command will proceed to check the enet module out of CVS. |
|---|
| 57 | Any problems with CVS access or request for write access should be |
|---|
| 58 | sent via email to @ref MailingList. |
|---|
| 59 | |
|---|
| 60 | */ |
|---|
| 61 | |
|---|
| 62 | /** |
|---|
| 63 | @page MailingList ENet Mailing List |
|---|
| 64 | |
|---|
| 65 | The <a href="http://lists.cubik.org/mailman/listinfo/enet-discuss">enet-discuss</a> list is for discussion of ENet, including bug reports or feature requests. |
|---|
| 66 | |
|---|
| 67 | */ |
|---|
| 68 | |
|---|
| 69 | /** |
|---|
| 70 | @page IRCChannel ENet IRC Channel |
|---|
| 71 | |
|---|
| 72 | Join the \#enet channel on the freenode IRC network (irc.freenode.net) for real-time discussion about the ENet library. |
|---|
| 73 | |
|---|
| 74 | */ |
|---|
| 75 | |
|---|
