move config.h to urcu/config.h and install it

[urcu.git] / README

diff --git a/README b/README
index a2cc296a480fe768d0b318cf9dcdd32002b656f6..fce568089b3182aada2a802939512cb99aa280b5 100644 (file)
--- a/README
+++ b/README
@@ -8,7 +8,23 @@ BUILDING
        ./configure
        make
        make install
-       
+
+       Hints:  Forcing 32-bit build:
+               * CFLAGS="-m32 -g -O2" ./configure
+
+               Forcing 64-bit build:
+               * CFLAGS="-m64 -g -O2" ./configure
+
+               Forcing a 32-bit build with 386 backward compatibility:
+               * CFLAGS="-m32 -g -O2" ./configure --target=i386-pc-linux-gnu
+
+ARCHITECTURES SUPPORTED
+-----------------------
+
+Currently, x86 (i386, i486, i586, i686), x86 64, PowerPC 32/64 and S390 are
+supported. The current use of sys_futex() makes it Linux-dependent, although
+this portability limitation might go away in a near future by using the pthread
+cond vars.
 
 QUICK START GUIDE
 -----------------
@@ -122,3 +138,13 @@ Usage of DEBUG_YIELD
 
        DEBUG_YIELD is used to add random delays in the code for testing
        purposes.
+
+SMP support
+
+       By default the library is configured to use synchronization primitives
+       adequate for SMP systems. On uniprocessor systems, support for SMP
+       systems can be disabled with:
+
+               ./configure --disable-smp-support
+
+       theoretically yielding slightly better performance.