Add a note about debugging
@@ -37,3 +37,22 @@ At this point you should be able to build and run tests from the root directory:
This installs the `mu` binary into `$GOPATH/bin`, which may now be run provided `make` exited successfully.
+## Debugging
+
+The Mu tools have extensive logging built in. In fact, we encourage liberal logging in new code, and addding new
+logging when debugging problems. This helps to ensure future debugging endeavors benefit from your sleuthing.
+
+All logging is done using Google's [Glog library](https://github.com/golang/glog). It is relatively barebones, and adds
+basic leveled logging, stack dumping, and other capabilities beyond what Go's built-in logging routines offer.
+
+The Mu command line has two flags that control this logging and that can come in handy when debugging problems. The
+`--logtostderr` flag spews directly to stderr, rather than the default of logging to files in your temp directory. And
+the `--verbose=n` flag (`-v=n` for short) sets the logging level to `n`. Anything greater than 3 is reserved for
+debug-level logging, greater than 5 is going to be quite verbose, and anything beyond 7 is extremely noisy.
+
+For example, the command
+
+ $ mu compile blueprint.yaml --logtostderr -v=5
+
+is a pretty standard starting point during debugging that will show a fairly comprehensive trace log of a compilation.
+
