aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-11-07 14:56:28 +0200
committerLoïc Hoguin <[email protected]>2014-11-07 14:56:28 +0200
commitdf5a4779bc3c5a5bffee4186a8f69408262de5d2 (patch)
tree2f0aa35775459fde86cd6ae0c18661362c63032c
parent34774e34ce6506f50dba7f0f3ff95c0eb0f50a61 (diff)
parentc9eb9023e06a169aa2107124def882a1496d9357 (diff)
downloaderlang.mk-1.2.0.tar.gz
erlang.mk-1.2.0.tar.bz2
erlang.mk-1.2.0.zip
Merge branch 'facorro.elvis.96.plugin.readme' of git://github.com/inaka/erlang.mk1.2.0
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 31f718b..bcb5042 100644
--- a/README.md
+++ b/README.md
@@ -331,6 +331,21 @@ EDoc options can be specified in Erlang format by defining
the `EDOC_OPTS` variable. For more information please see
`erl -man edoc`.
+Elvis plugin
+------------
+
+This plugin is available by default. It adds the following
+target:
+
+`elvis` runs Elvis style checker for this application.
+
+The `ELVIS_CONFIG` variable specifies the location of the
+configuration file which holds the rules to be applied.
+If there's no `elvis.config` file the default one will be
+downloaded. When the `ELVIS` variable points to a non-existing
+file then the `elvis` executable will be downloaded as well.
+Any other option should go in the `ELVIS_OPTS` variable.
+
ErlyDTL plugin
--------------