diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
@@ -224,6 +224,22 @@ If `{id, "git"},` is found in your project's `.app.src`, the extended output of `git describe ...` will replace it. This can be retrieved at runtime via `application:get_key/2`. +Updating erlang.mk +------------------ + +You can update erlang.mk by running `make erlang-mk`. This automated +update will always take the latest erlang.mk version, compile it and +replace the erlang.mk of your project with the updated version. + +If your project includes a `build.config`, erlang.mk will use it +when building the updated version. + +The `ERLANG_MK_BUILD_CONFIG` variable can be used to rename the +`build.config` file. + +The `ERLANG_MK_BUILD_DIR` variable contains the path to the +temporary directory used to build the updated erlang.mk. + Bootstrap plugin ---------------- @@ -320,6 +336,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 -------------- |