x

commit 110506e3789b28df9fd2777e87b202018139fde5
parent 88c60ed6e14acbaaf2240011fc4830e1bda7a32f
Author: Oliver Lowe <o@olowe.co>
Date:   Fri, 16 Jun 2023 15:56:05 +1000

Automate generation of README with command summaries

Diffstat:
M
README
 | 
8
++++++++
A
mkfile
 | 
3
+++
A
readme.proto
 | 
6
++++++
A
summary.sh
 | 
8
++++++++

4 files changed, 25 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -1,3 +1,11 @@
 Programs, configuration and documentation that don't fit anywhere else.
 
 To install, run install.sh.
+
+The following commands are provided:
+
+hits - count web traffic
+hlsget - download the contents of a HLS playlist
+jsfmt - format javascript source code
+knocknocauth - create and close knocknoc sessions
+webpaste - create a web paste on webpaste.olowe.co
diff --git a/mkfile b/mkfile
@@ -0,0 +1,3 @@
+README: readme.proto summary.sh
+	cp readme.proto README
+	./summary.sh >> README
diff --git a/readme.proto b/readme.proto
@@ -0,0 +1,6 @@
+Programs, configuration and documentation that don't fit anywhere else.
+
+To install, run install.sh.
+
+The following commands are provided:
+
diff --git a/summary.sh b/summary.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+
+for f in man/*
+do
+	name=`basename $f | sed 's/\.[0-9]$//'`
+	description=`grep .Nd $f | sed 's/^\.Nd //'`
+	echo $name '-' $description
+done