summaryrefslogtreecommitdiff
path: root/README.template
diff options
context:
space:
mode:
Diffstat (limited to 'README.template')
-rw-r--r--README.template16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.template b/README.template
new file mode 100644
index 0000000..8c254e4
--- /dev/null
+++ b/README.template
@@ -0,0 +1,16 @@
+Here is a script and a Makefile for generating a <NAME> docset for Dash. The script is loosely based on benzado's script for GNU Make https://github.com/benzado/gnu-make-dash-docset.
+
+- <NAME>: <UPSTREAM LINK>
+- Dash: https://kapeli.com/dash
+
+To generate a docset from the latest edition of the <NAME> Manual, simply
+execute `make` from the same directory as this README file. The latest edition
+will be downloaded from <UPSTREAM HOST> and packaged appropriately.
+
+Requirements:
+
+- any POSIX-compliant shell
+- curl
+- make
+- pup
+- sqlite3