Permalink
Browse files

Note the requirements for running enet on Mac OS X and Linux.

  • Loading branch information...
1 parent ab208e6 commit e8bb85dff27130ae0c4f3e57da5d8c6c585c6400 @archaelus archaelus committed Jan 21, 2010
Showing with 16 additions and 8 deletions.
  1. +16 −8 README.rst
View
24 README.rst
@@ -6,21 +6,29 @@ ENet is a pure Erlang network stack that can be used to encode and
decode a variety of common packet formats.
The project includes a port program that can be used to send and
-receive ethernet frames via the /dev/tap0 device.
+receive ethernet frames via the ``/dev/tap0`` device.
+
+Requirements
+============
+
+Mac OS X
+ ``libevent``, OS X 10.6.1 (probably compatible with other versions), the
+ ``tuntaposx`` driver ( http://tuntaposx.sourceforge.net ) loaded, ``sudo``.
+
+Linux
+ libevent, the ``tun`` module loaded, the ``tunctl`` program (usually
+ in the ``uml-utilities`` package``), ``sudo``.
Drivers
=======
Mac OS X
- The ``enet_tap`` port program requires libevent, Mac OS X (tested
- on OS X 10.6.1) and the tuntaposx driver
- (http://tuntaposx.sourceforge.net). Takes a mandatory option ``-f``
- to specify which tap device to use. (normally "/dev/tap0")
+ The ``enet_tap`` port program. Takes a mandatory option ``-f`` to
+ specify which tap device to use. (normally "/dev/tap0")
Linux
- The ``enet_tap`` port program requires libevent and a linux kernel
- with the 'tun' module loaded. Takes a mandatory ``-i`` argument that
- specifies which tap device to use. (normally "tap0")
+ The ``enet_tap`` port program. Takes a mandatory ``-i`` argument
+ that specifies which tap device to use. (normally "tap0")
Building the Driver

0 comments on commit e8bb85d

Please sign in to comment.