summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/proposal/bin/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/proposal/bin/README')
-rw-r--r--macros/latex/contrib/proposal/bin/README32
1 files changed, 32 insertions, 0 deletions
diff --git a/macros/latex/contrib/proposal/bin/README b/macros/latex/contrib/proposal/bin/README
new file mode 100644
index 0000000000..e33b26bf25
--- /dev/null
+++ b/macros/latex/contrib/proposal/bin/README
@@ -0,0 +1,32 @@
+This directory contains the binaries for the proposal class.
+
+We have three utilities:
+- filedate and checksum are for managing metadata in the
+ DTX files of the sTeX distribution (written in perl)
+- Modparse.pm is a perl library they depend on
+- generate-issues is a ruby library that generates issues
+ on http://github.com for the project (experimental)
+
+============== Details =================
+
+checksum
+ "enable, update, and disable checksums in DTX files"
+
+Usage:
+ checksum [options]
+
+Options:
+ -- disable disable the checksum by wrapping in \iffalse ... \fi
+ -- enable remove those again
+ -- update update to the correct checksum
+
+
+filedate <input filename> <newdate>
+
+Purpose:
+ Update the dates for a \ProvidePackage invocation in a given .dtx source
+
+Example:
+ filedate omdoc.dtx
+
+