[PATCH] update the README in a few places.

[elogind.git] / README

diff --git a/README b/README
index fffa7939879a1d814d30425490715dcb907c4497..123fce6a1b4c81e262a9a8a15b420b6bb0bbf880 100644 (file)
--- a/README
+++ b/README
@@ -8,6 +8,8 @@ To use:
 
 - You must be running a 2.6 version of the Linux kernel.
 
+- Your 2.6 kernel must have had CONFIG_HOTPLUG enabled when it was built.
+
 - Make sure sysfs is mounted.  udev will figure out where sysfs is mounted, but
   the traditional place for it is at /sys.  You can mount it by hand by running:
        mount -t sysfs none /sys
@@ -25,6 +27,30 @@ To use:
 - Build the project:
        make
 
+  Note:
+      There are a number of different flags that you can use when building
+      udev.  They are as follows:
+       prefix - set this to the default root that you want udev to be
+               installed into.  This works just like the 'configure --prefix'
+               script does.  Default value is ''.  Only override this if you
+               really know what you are doing.
+       USE_KLIBC - if set to 'true', udev is built and linked against the included
+               version of klibc.  Default value is 'false'.
+       DEBUG - if set to 'true', debugging messages will be sent to the syslog
+               as udev is run.  Default value is 'false'.
+       USE_DBUS -  if set to 'true', DBUS messages will be sent everytime udev
+               creates or removes a device node.  This requires that DBUS
+               development headers and libraries be present on your system to
+               build properly.  Default value is 'false'.
+
+      So, if you want to build udev using klibc with debugging messages, you
+      would do:
+       make USE_KLIBC=true DEBUG=true
+
+      Note: If you want to use klibc, you will have to set up the "linux"
+            symlink properly.  See the file klibc/klibc/README and pay
+           attention to step "a)" there.
+
 - Install the project:
        make install
 
@@ -41,18 +67,18 @@ To use:
        make uninstall
 
 
-Things are still quite rough, and it's a bit beyond proof of concept
-code.  Help is very much appreciated, see the TODO file for a list of
-things left to be done.
+Things are still quite rough, but it should work properly.  If nothing
+seems to happen, make sure your build worked properly by running the
+udev-test.pl script as root in the test/ subdirectory of the udev source
+tree.
+
+Development and documentation help is very much appreciated, see the TODO
+file for a list of things left to be done.
 
-If you want to build using klibc, use the Makefile.klibc file:
-       - read the klibc/klibc/README file for how to set up the linux
-         symlink properly.
-       - make clean
-       - make -f Makefile.klibc
-and marvel at the tiny binary you just created :)
 
-Any comment/questions/concerns please let me know.
+Any comment/questions/concerns please let me and the other udev developers
+know by sending a message to the linux-hotplug-devel mailing list at:
+       linux-hotplug-devel@lists.sourceforge.net
 
 greg k-h
 greg@kroah.com