mainpage.dox 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. /** @mainpage enet
  2. <center>http://enet.bespin.org</center>
  3. <hr>
  4. ENet's purpose is to provide a relatively thin, simple and robust
  5. network communication layer on top of UDP (User Datagram Protocol).
  6. The primary feature it provides is optional reliable, in-order
  7. delivery of packets.
  8. ENet is NOT intended to be a general purpose high level networking
  9. library that handles authentication, lobbying, server discovery,
  10. compression, encryption and other high level, often application level
  11. or dependent tasks.
  12. @ref Features
  13. @ref SourceDistro
  14. @ref Installation
  15. @ref Tutorial
  16. @ref MailingList
  17. @ref FAQ
  18. @ref License
  19. */
  20. /**
  21. @page SourceDistro Source Distribution
  22. You can retrieve the source to ENet by downloading it in either .tar.gz form
  23. or accessing the cvs distribution directly.
  24. The most recent stable release (1.0) can be downloaded <a href="http://enet.bespin.org/download/enet-1.0.tar.gz">here</a>.
  25. To access ENet via anonymous CVS, you must use the CVSROOT
  26. :pserver:anonymous\@bespin.org:/var/lib/cvs/enet with an empty
  27. password.
  28. @code
  29. $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet login
  30. @endcode
  31. Hit the return key when prompted for a password.
  32. @code
  33. $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet co -l .
  34. $ cvs -z3 co enet
  35. @endcode
  36. This will create a CVS directory in the current directory, and with
  37. the second command will proceed to check the enet module out of CVS.
  38. Any problems with CVS access or request for write access should be
  39. sent via email to @ref MailingList.
  40. */
  41. /**
  42. @page MailingList ENet Mailing List
  43. The <a
  44. href="http://lists.cubik.org/mailman/listinfo/enet-discuss">
  45. enet-discuss</a> list is for discussion of ENet, including bug reports
  46. or feature requests.
  47. */