Merge pull request #10 from ojacobson/checks-to-tools

Extracted checks into a tools directory.

1 files changed, 26 insertions, 0 deletions

diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 0000000..8c1b7e0
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,26 @@
+# Local Tools
+
+The scripts in this directory assume they will be run from the root of the
+project, as `tools/NAME`. They contain brief, branch-free, composable scripts
+intended to be run to achieve frequent goals. They act as a shared shell
+history, of a sorts, and as a place to put command-line-ish code that needs to
+be shared by multiple components.
+
+Each script begins with a brief comment demonstrating the intended invocation
+and the effects.
+
+## Authoring
+
+Tools _should_ begin with a shebang or shell `set` expression that enables
+exiting on failure and that enables command echoing, followed by a documentation
+comment:
+
+```bash
+#!/bin/bash -ex
+
+# tools/my-example-tool
+#
+# Runs all example tasks.
+
+: …
+```