git » libfilo » commit 1f60886

Write something in the README file.

author Alberto Bertogli
2005-04-24 01:04:53 UTC
committer Alberto Bertogli
2005-04-24 01:04:53 UTC
parent fff6cedc8521aa2ae94e0962d71fd459de212a96

Write something in the README file.

README +33 -2

diff --git a/README b/README
index beeda86..e42f51f 100644
--- a/README
+++ b/README
@@ -1,4 +1,35 @@
 
-Questions or complaints about the name are responsability of Luca
-(luca@llucax.hn.org).
+libfilo - A library for file locking.
+Alberto Bertogli (albertogli@telpin.com.ar)
+-------------------------------------------
+
+This is a small portable library to do userspace file locking, like fcntl(),
+lockf() or flock(), but within threads.
+
+If you want multiple threads to access a file simultaneously, you will
+probably need some kind of locking to avoid them stepping on each other and
+corrupting everything.
+
+Currently, there is no standard way of doing this:
+ * fcntl() ignores threads, and only works between processes.
+ * flock() is not really standard and doesn't work well over NFS.
+ * lockf(), while it is documented in POSIX, it's often implemented using
+	fcntl() so it's also useless.
+
+
+So this library allows you to do read/write file locking with byte
+granularity with fcntl-like semantics within threads and entirely in
+userspace. What a deal.
+
+
+To see how to install it, please read the INSTALL file.
+Documentation coming soon.
+
+It is licensed under the Open Software License version 2.1.
+
+Comments and patches are always welcome; please send them to my email address,
+albertogli@telpin.com.ar.
+
+Thanks,
+		Alberto