From c7325f5be1252d148cfbcb526fe22e1446f30089 Mon Sep 17 00:00:00 2001
From: speedie <speedie@speedie.site>
Date: Tue, 15 Aug 2023 14:30:37 +0200
Subject: [PATCH] Add documentation creation and checksums

---
 Makefile              | 10 +++++++++-
 README.md             | 16 +++++++++++++++-
 my-awesome-program    |  2 +-
 my-awesome-program.1  | 18 ++++++++++++++++++
 my-awesome-program.md | 13 +++++++++++++
 5 files changed, 56 insertions(+), 3 deletions(-)
 create mode 100644 my-awesome-program.1
 create mode 100644 my-awesome-program.md

diff --git a/Makefile b/Makefile
index 614f96a..cce35aa 100644
--- a/Makefile
+++ b/Makefile
@@ -6,6 +6,7 @@ help:
 	@echo "make install     Install ${NAME}."
 	@echo "make uninstall   Uninstall ${NAME}."
 	@echo "make clean:      Remove tarballs."
+	@echo "make docs        Create documentation for ${NAME}."
 	@echo "make dist        Create distro package for ${NAME}."
 	@echo "make pkg_arch    Create Arch package ${NAME}."
 
@@ -20,13 +21,20 @@ uninstall:
 clean:
 	rm -f *.tar* *zst* *${NAME}-${VER}.PKGBUILD
 
-dist: clean
+docs: clean
+	printf "%% ${NAME}(1) ${VER} | ${DESC}\n" > .man.md
+	pandoc --standalone --to man .man.md -o ${NAME}.1
+	rm -f .man.md
+
+dist: docs
 	mkdir -p ${NAME}-${VER}
 	cp ${NAME} README.md LICENSE Makefile *.mk ${NAME}-${VER}
 	[ -f "PKGBUILD" ] && cp -f PKGBUILD ${NAME}-${VER} || :
 	tar -cf ${NAME}-${VER}.tar ${NAME}-${VER}
 	gzip ${NAME}-${VER}.tar
 	rm -rf ${NAME}-${VER}.tar ${NAME}-${VER}
+	md5sum ${NAME}-${VER}.tar.gz | cut -d ' ' -f 1 > ${NAME}-${VER}.tar.gz.md5
+	sha256sum ${NAME}-${VER}.tar.gz | cut -d ' ' -f 1 > ${NAME}-${VER}.tar.gz.sha256
 	gpg --detach-sign --yes --local-user $$(whoami) ${NAME}-${VER}.tar.gz || :
 
 pkg_arch: dist
diff --git a/README.md b/README.md
index ef51119..7cbcb7d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # shell-makefile-template
 
-Shell script Makefile template with Arch PKGBUILD creation.
\ No newline at end of file
+Shell script Makefile template with Arch PKGBUILD creation.
+
+## Features
+
+This makefile does the following:
+
+- Handles installation of the script
+- Handles man pages using pandoc
+- Handles distro packages (tarballs)
+- Automatically prepares a PKGBUILD which can create an Arch Linux
+package for your script
+
+## Usage
+
+Edit `options.mk` to fit your program.
diff --git a/my-awesome-program b/my-awesome-program
index ac8bd6e..8db8d01 100755
--- a/my-awesome-program
+++ b/my-awesome-program
@@ -1,4 +1,4 @@
 #!/bin/sh
 # my-awesome-program
 
-printf "%s:The makefile works perfectly.\n" "$0"
+printf "%s: The makefile works perfectly.\n" "$0"
diff --git a/my-awesome-program.1 b/my-awesome-program.1
new file mode 100644
index 0000000..bb41b2a
--- /dev/null
+++ b/my-awesome-program.1
@@ -0,0 +1,18 @@
+.\" Automatically generated by Pandoc 3.1.2
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "my-awesome-program" "1" "" "0.1" "My awesome description here"
+.hy
diff --git a/my-awesome-program.md b/my-awesome-program.md
new file mode 100644
index 0000000..7584a83
--- /dev/null
+++ b/my-awesome-program.md
@@ -0,0 +1,13 @@
+# my-awesome-program
+
+This is the man page for my awesome program
+
+## Arguments
+
+`-h`
+:    Help
+
+## License
+
+my-awesome-program is licensed under the GNU GPLv3 license.
+The documentation is licensed under the CC-BY-SA 4.0 license.