From d190c9c3d4ecd8a3bef658b975a6596a8cf1acbc Mon Sep 17 00:00:00 2001
From: Christoph Lohmann <20h@r-36.net>
Date: Sat, 28 Apr 2012 20:31:09 +0200
Subject: Add README.md.

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95ae6f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# NetLink DEVice manager
+
+## Installation
+
+	# edit config.mk according to your needs
+	% make
+	% make PREFIX=/ MANPREFIX=/usr/share/man install
+
+## nldev + mdev 
+
+For getting nldev and mdev to work use the following instructions.
+
+	% cd /tmp
+	% git clone git://busybox.net/busybox.git
+	% cd busybox
+	% make
+	% cp busybox /bin
+	% cd /bin
+	% ln -s busybox mdev
+
+In you init scripts you will need to trigger:
+
+	% run_nldev &
+	% nltrigger all
+
+### CAUTION
+
+Because of the asynchronous initialisation of every device that
+needs some firmware or some that just take some time to appear
+in the kernel, don't assume interfaces to be there after startup.
+Always add some step to check for the devices to be there or do
+them per service.
+
-- 
cgit v1.2.3