From: W. Trevor King <wking@drexel.edu>
Date: Thu, 7 Oct 2010 13:15:29 +0000 (-0400)
Subject: Add _script/README and fix _script/math.sh documentation.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=bcd463e7f6e757181be12953fb5ca0765f06b138;p=parallel_computing.git

Add _script/README and fix _script/math.sh documentation.
---

diff --git a/_script/README b/_script/README
new file mode 100644
index 0000000..99e8084
--- /dev/null
+++ b/_script/README
@@ -0,0 +1,27 @@
+Most of the content in the source repository is ready-to-serve, but
+there are some files that must be generated from the raw source.  The
+scripts in this directory automatically generate those files.  Run
+  build-all.sh
+from anywhere inside the source repository to generate the files, and
+  clean-all.sh
+to restore the source repository to a pristine state.
+
+If you want more finely grained control,
+  build.sh DIR
+builds everything at and below a directory DIR, except for tables of
+contents not attached to DIR's.
+  clean.sh DIR
+undoes everything that buld.sh did.
+  math.sh DIR
+converts any itex contained in files matching *.itex2MML to MathML.
+You'll need itex2MML
+  http://golem.ph.utexas.edu/~distler/blog/itex2MML.html
+installed for this to work.
+  make_tar.sh
+generates tarballs for any directory containing a .make_tar file.
+
+You may have to add the _script/ directory to your PATH for the
+scripts to work.  You can accomplish that from the root source
+directory with
+  export PATH="$PATH:$(pwd)/_script"
+if you're using the Bash shell.  You're on your own for other shells.
diff --git a/_script/math.sh b/_script/math.sh
index 4b5b916..34aa455 100755
--- a/_script/math.sh
+++ b/_script/math.sh
@@ -1,13 +1,6 @@
 #!/bin/bash
 #
-# (re)generate source tarballs for any directory containing a
-# .make_tar file.  Will *not* include any dot files (e.g. .make_tar)
-# .make_tar should contain a relative path to the directory that
-# provides the tarball's base name.  For example
-#   $ echo some_dir/src/.make_tar
-#   ../
-# calls for an output
-#   some_dir/src/some_dir.tar.gz
+# (re)generate MathML files from *.itex2MML source.
 
 ITEX2MML=itex2MML
 CLEAN=0