Resources: res_new() requires an active pool

[libucw.git] / ucw / doc / basics.txt

diff --git a/ucw/doc/basics.txt b/ucw/doc/basics.txt
index 4400a7dc337da03c735071f422e6b5e90fb48452..42f009778e1ce3f06f0911f6fccf3536068dbcd5 100644 (file)
--- a/ucw/doc/basics.txt
+++ b/ucw/doc/basics.txt
@@ -1,9 +1,33 @@
 LibUCW Basics
 =============
 
-*Currently, only the logging functions are documented.*
+Every program using LibUCW should start with `#include <ucw/lib.h>` which
+brings in the most frequently used library functions, macros and types.
+This should be done before you include any of the system headers, since
+`lib.h` defines the feature macros of the system C library.
+
+Portability
+-----------
+
+LibUCW is written in C99 with a couple of GNU extensions mixed in where needed.
+It currently requires the GNU C compiler version 4.0 or newer, but most modules
+should be very easy to adapt to a different C99 compiler. (A notable exception
+is `stkstring.h`, which is heavily tied to GNU extensions.)
+
+The library has been developed on Linux with the GNU libc and it is known to run
+on Darwin, too. The authors did not try using it on other systems, but most of
+the code is written for a generic POSIX system, so porting to any UNIX-like system
+should be a piece of cake.
 
 ucw/lib.h
 ---------
+*Only partially documented.*
 
 !!ucw/lib.h
+
+ucw/config.h
+------------
+This header contains the standard set of types used by LibUCW. It is automatically
+included by `ucw/lib.h`.
+
+!!ucw/config.h