about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-06-07 21:33:31 -0700
committerEric Wong <normalperson@yhbt.net>2009-06-07 21:41:17 -0700
commitfcab3eaea57a25185d88b529ed1620e67c9c2080 (patch)
tree1fef9a29136cdd4c3e483262f6284af6a7a849c7
parent6e60f84bb1b7b4814301d0e21c82e2b4a5a2634a (diff)
downloadpcu-fcab3eaea57a25185d88b529ed1620e67c9c2080.tar.gz
Documentation updates
* Generate homepage using the README
* More git repository information
* Remove references to non-existent pcu(7) manpage
-rw-r--r--Makefile6
-rw-r--r--README18
-rw-r--r--pcu-fadvise.1.txt2
-rw-r--r--pcu-mincore.1.txt2
4 files changed, 23 insertions, 5 deletions
diff --git a/Makefile b/Makefile
index 64b0154..d846d32 100644
--- a/Makefile
+++ b/Makefile
@@ -62,4 +62,10 @@ clean:
         $(RM) $(PCU_BIN) $(DISTNAME).tar.gz* GIT-VERSION-FILE
         $(RM) $(man1)
 
+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 $@+ $@
+
 .PHONY: .FORCE-GIT-VERSION-FILE install install-man man
diff --git a/README b/README
index e80258b..cf6c57c 100644
--- a/README
+++ b/README
@@ -11,8 +11,20 @@ See manpages for the individual commands for more details.  Neither
 command requires privileges other than read access to the files
 specified on the command-line.
 
+You may clone the source repository via git:
+
+* git://git.bogomips.org/pcu.git
+* <http://git.bogomips.org/pcu.git>
+* git://repo.or.cz/pcu.git (mirror)
+* <http://repo.or.cz/r/pcu.git> (mirror)
+
+You may also brows the source code or obtain tarballs from cgit:
+
+* <http://git.bogomips.org/cgit/pcu.git>
+
+Or via gitweb:
+
+* <http://repo.or.cz/w/pcu.git>
+
 pcu is copyright Eric Wong <normalperson@yhbt.net> and contributors.
 It is covered under the GNU General Public License, version 2.
-
-You man obtain the source code via git or tarballs from cgit:
-  <http://git.bogomips.org/cgit/pcu.git/>
diff --git a/pcu-fadvise.1.txt b/pcu-fadvise.1.txt
index e7f26a9..9e10c8b 100644
--- a/pcu-fadvise.1.txt
+++ b/pcu-fadvise.1.txt
@@ -37,7 +37,7 @@ OUTPUT
 ENVIRONMENT
   none
 SEE ALSO
-  posix_fadvise(2), pcu(7)
+  posix_fadvise(2)
 BUGS
   None known. Email the author if you find any.
 AUTHOR
diff --git a/pcu-mincore.1.txt b/pcu-mincore.1.txt
index e095621..d2334e5 100644
--- a/pcu-mincore.1.txt
+++ b/pcu-mincore.1.txt
@@ -27,7 +27,7 @@ OUTPUT
   incore is a boolean value indicating whether or not the page beginning
   at a particular offset is cached in resident memory or not.
 SEE ALSO
-  mincore(2), pcu(7)
+  mincore(2)
 BUGS
   None known. Email the author if you find any.
 AUTHOR