osl-0.2.0.

[osl.git] / README

diff --git a/README b/README
index c8cfff0824f9e76322601ee1fda525ae244a206d..c9606ae1618b942671384b6157461e4dc8e05156 100644 (file)
--- a/README
+++ b/README
@@ -6,37 +6,50 @@ system provides.
 
 Libosl is simple:
 
 
 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 network support for network-access and libosl
-       only uses a very rudimentary table locking mechanism.
+- 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 in included in the libosl package.
+- 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:
 
 
 Libosl is fast:
 

-       - It uses sha1 hashes for content-based addressing.
+- It uses sha1 hashes for content-based addressing.

 
 

-       - Red-black trees are used to make lookups fast.
+- Red-black trees are used to make lookups fast.

 
 Libosl is portable:
 
 
 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:
 
 
 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.
 
 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.