git » nmdb » commit a0c0eaf

Improve the README a bit.

author Alberto Bertogli
2006-09-15 05:38:44 UTC
committer Alberto Bertogli
2006-09-15 05:38:44 UTC
parent adc64ecf7ed443e6f37cbe742073a70ae16e91fd

Improve the README a bit.

README +12 -8

diff --git a/README b/README
index 31d28f4..7c2fb8d 100644
--- a/README
+++ b/README
@@ -7,9 +7,9 @@ nmdb is a network database that uses the TIPC protocol to communicate with
 it's clients.
 
 It consists of an in-memory cache, that saves (key, value) pairs, and a
-persistant backend that stores the pairs on disk.
+persistent backend that stores the pairs on disk.
 
-Both work combined, but the use of the persistant backend is optional, so you
+Both work combined, but the use of the persistent backend is optional, so you
 can use the server only for cache queries, pretty much like memcached.
 
 This source distribution is composed of several parts: the server called
@@ -24,16 +24,20 @@ http://auriga.wearlab.de/~alb/nmdb.
 How to compile, test and install
 --------------------------------
 
-You will need to be running a kernel >= 2.6.16, and to have kernel headers
-also >= 2.6.16. Alternatively, you can run a TIPC patched kernel, and have the
-tipc.h header be put somewhere in the include path by hand.
+Requisites:
+ * Running Linux kernel >= 2.6.16 with TIPC enabled.
+ * Kernel headers also >= 2.6.16. Alternatively, you can run a TIPC patched
+     kernel, and have the tipc.h header be put somewhere in the include path
+     by hand.
+ * libevent (http://www.monkey.org/~provos/libevent/).
+ * qdbm (http://qdbm.sf.net/).
 
 To compile the server and the library, you can just use "make" on their
 directories. To install them, use "make install".
 
-To test the application, start the server and then go to the library
-directory. Run "make tests", and then use the "test1c" and "test2c" to test
-the cache layer, and "test1d" and "test2d" to test the database backend.
+To run some tests, start the server and then go to the library directory. Run
+"make tests", and then use the "test1c" and "test2c" to test the cache layer,
+and "test1d" and "test2d" to test the database backend.
 
 To compile the Python bindings, you need to have the library already
 installed. Go to the directory and run "python setup.py install", which will