From e024be4e45fe08c83b3132bd227f3065695c231d Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 7 Jun 2009 21:50:02 -0700 Subject: Fixup README to use as a homepage --- Makefile | 6 ++++++ README | 35 ++++++++++++++++++++++++++++++++++- 2 files changed, 40 insertions(+), 1 deletion(-) 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)," > $@+ + 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 + 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 +* +* git://repo.or.cz/libnodelay.git (mirror) +* (mirror) + +You may also browse the source code or obtain tarballs from cgit: + +* + +Or via gitweb: + +* + +Copyright +--------- + +libnodelay is copyright (C) 2009 Eric Wong . +It is covered under the GNU Lesser General Public License, version 3. -- cgit v1.2.3-24-ge0c7