Adds examples to `.dir-locals.el` README section.

Provies examples for customizing project compilation command string and
project test command string.

Fixes existing example code.

Adds documentation of using `.dir-locals.el` along with defcustom settings.