add README

tonyrog · Feb 12, 2015 · f403913 · f403913
1 parent e1b3203
commit f403913
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -1 +1,2 @@
 Ruslan Babayev <[email protected]>
+Andreas Schultz <[email protected]>
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# dhcp
+
+This is DHCP Server in Erlang for running on Linux.
+
+The Linux dependency comes mostly from the use of a special ioctl to inject ARP information into the kernel. The alternative to that would be to use raw packet socket, but those are not supported in Erlang.
+
+The bind-to-interface socket option is also Linux specific, but the server could work without it.
+
+## Requirements
+
+* Linux
+* Erlang (>= R17, older probably works as well)
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		Ruslan Babayev <[email protected]>
		Andreas Schultz <[email protected]>