Merge branch 'refs/heads/t/sha3' into master

[osl.git] / README

diff --git a/README b/README
index 23f177f6626f2dc5fd7465e96fb7303fbe5566b8..c9606ae1618b942671384b6157461e4dc8e05156 100644 (file)
--- a/README
+++ b/README
@@ -6,34 +6,50 @@ system provides.
 
 Libosl is simple:
 
-       - For libosl, all data stored in the osl tables are blobs,
-       libosl will never try to interpret the table contents.
+- For libosl, all data stored in the osl tables are blobs,
+libosl will never try to interpret the table contents.
 
-       - There is no fancy query language but only a relatively
-       simple C-API.
+- There is no fancy query language but only a relatively
+simple C-API.
 
-       - There's no support for network-access and libosl does not
-       use any table locking.
+- There's no support for network-access and libosl only uses a very
+rudimentary table locking mechanism.
+
+- There are no dependencies on external libraries. An augmented
+version of the red-black tree implementation of the linux
+kernel is included in the libosl package.
 
 Libosl is fast:
 
-       - It uses sha1 hashes for content-based addressing.
+- It uses sha1 hashes for content-based addressing.
 
-        - An augmented version of the rbtree implementation of the
-        linux kernel is used for lookups.
+- Red-black trees are used to make lookups fast.
 
 Libosl is portable:
 
-       - It is known to compile and run on Linux, MacOS, FreeBSD,
-       NetBSD and Solaris.
+- It is known to compile and run on Linux, FreeBSD, NetBSD. It might
+work on other Unix systems as well.
 
-       - Content and metadata is stored in an endian-agnostic way.
+- Content and metadata is stored in an endian-agnostic way.
 
 Libosl is open source:
 
-       - Licensed under the GPL, version 2.
+- Licensed under the [GNU General Public License, Version
+2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 
 Apart from the library itself, the package also contains simple
 examples and an fsck program, oslfsck, which can be used to recover
 from corrupted tables due to system crashes or bugs in the application
 or the library.
+
+Resources:
+
+- Git clone URL: git://git.tuebingen.mpg.de/osl.git
+- [Gitweb](http://git.tuebingen.mpg.de/osl.git)
+- [Author Home Page](http://people.tuebingen.mpg.de/maan)
+- [Project Page](http://people.tuebingen.mpg.de/maan/osl)
+- Email: [Andre Noll](mailto:maan@tuebingen.mpg.de)
+
+Comments and bug reports are welcome. Please provide enough info
+such as the version of osl you are using and relevant parts of
+the logs.