beacons recognized, minimal gui working

[my-code/hdw-sniff.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..ab0d0c7
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+hdw-sniff
+---------
+
+ieee 802.11 sniffer
+
+
+install
+#######
+
+- required:
+
+       - my minimalistic apis (get it via cvs from hackdaworld.org)
+       - libpcap (freshmeat may help)
+       - wlan card supporting monitor mode
+
+- build: (an example)
+
+       mkdir ~/foo && cd ~/foo
+       cvs -d:pserver:anonymous@hackdaworld.org:/my-code co api
+       cvs -d:pserver:anonymous@hackdaworld.org:/my-code co hdw-sniff
+       cd hdw-sniff
+       ./configure
+       make
+
+- usage: (another example)
+
+       ./hdw-sniff -m monitor -d wlan0
+
+
+troubleshooting
+###############
+
+irc: server = irc.hackdaworld.org , channel = #hackdaworld
+email: hackbard@hackdaworld.org
+
+
+have fun!