about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-06-07 21:50:02 -0700
committerEric Wong <normalperson@yhbt.net>2009-06-08 01:35:12 -0700
commite024be4e45fe08c83b3132bd227f3065695c231d (patch)
tree2203e6d2dbe04b0379ee0eedce3c62127311cb35
parent47a36ae531f4355bed1723b6edf902bf8db8292a (diff)
downloadlibnodelay-e024be4e45fe08c83b3132bd227f3065695c231d.tar.gz
Fixup README to use as a homepage v0.0.1
-rw-r--r--Makefile6
-rw-r--r--README35
2 files changed, 40 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 7569e63..4e44277 100644
--- a/Makefile
+++ b/Makefile
@@ -32,3 +32,9 @@ test: libnodelay.so
         grep setsockopt.*TCP_NODELAY test-server.out
         grep setsockopt.*TCP_NODELAY test-client.out
         $(RM) test-server.out test-client.out
+
+index.html: title = $(shell sed -ne 1p < $<)
+index.html: README
+        markdown $< | (tidy -q 2>/dev/null || true) | \
+          sed "s,<title></title>,<title>$(title)</title>," > $@+
+        mv $@+ $@
diff --git a/README b/README
index 5d12767..04d80c0 100644
--- a/README
+++ b/README
@@ -9,16 +9,49 @@ for latency-sensitive applications that use TCP.
 
 More about Nagle's algorithm is here:
 
-  http://en.wikipedia.org/wiki/Nagle%27s_algorithm
+  <http://en.wikipedia.org/wiki/Nagle%27s_algorithm>
 
 Home directory Installation
 ---------------------------
 
+This will install libnodelay.so in your $HOME/lib
+
         $ make
         $ make install
 
 System-wide Installation
 ------------------------
 
+This will install libnodelay.so in /usr/lib
+
         $ make
         # make install prefix=/usr
+
+Usage
+-----
+
+        $ LD_PRELOAD=/path/to/libnodelay.so YOUR_COMMAND
+
+Development
+-----------
+
+You may clone the source repository via git:
+
+* git://git.bogomips.org/libnodelay.git
+* <http://git.bogomips.org/libnodelay.git>
+* git://repo.or.cz/libnodelay.git (mirror)
+* <http://repo.or.cz/r/libnodelay.git> (mirror)
+
+You may also browse the source code or obtain tarballs from cgit:
+
+* <http://git.bogomips.org/cgit/libnodelay.git>
+
+Or via gitweb:
+
+* <http://repo.or.cz/w/libnodelay.git>
+
+Copyright
+---------
+
+libnodelay is copyright (C) 2009 Eric Wong <normalperson@yhbt.net>.
+It is covered under the GNU Lesser General Public License, version 3.