Permalink
Browse files

Add installation example

  • Loading branch information...
1 parent 3663bd0 commit 3054c0ea46fa71167da9f7b463c5943a0d583c95 @mranney mranney committed Jun 9, 2010
Showing with 17 additions and 0 deletions.
  1. +17 −0 README.md
View
@@ -29,6 +29,23 @@ I want to build up decoders and printers for all popular protocols. I'm already
and 802.11 "monitor" mode. If you want to write a decoder or printer for another protocol, let me know,
or just send me a patch.
+## Installation
+
+You will need `libpcap` installed. Most OSX machines seem to have it. All major Linux distributions have it available
+either by default or with a package like `libpcap-dev`.
+
+Clone the repo somehow, probably like this:
+
+ git clone git://github.com/mranney/node_pcap.git
+
+To compile the native code bindings, do this:
+
+ cd node_pcap
+ node-waf configure build
+
+Assuming it built without errors, you should be able to run the examples and then write your own packet
+capture programs.
+
## Usage

0 comments on commit 3054c0e

Please sign in to comment.