r2878: Basic userspace cm info.

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..85e84af46279b19d87a1a6c9701fa04421af8f5e 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,29 @@
+This README is for userspace cm library.
+
+Building
+
+To make this directory, run:
+./autogen.sh && ./configure && make && make install
+
+Typically the autogen and configure steps only need be done the first
+time unless configure.in or Makefile.am changes.
+
+Libraries are installed by default at /usr/local/lib/infiniband.
+
+Device files
+
+The userspace CM uses a single device file regardless of the number
+of adapters or ports present.
+
+To create the appropriate character device file automatically with
+udev, a rule like
+
+    KERNEL="ucm", NAME="infiniband/%k", MODE="0666"
+
+can be used.  This will create the device node named
+
+    /dev/infiniband/ucm
+
+or you can create it manually
+
+  mknod /dev/infiniband/ucm c 231 255