diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 19 insertions, 7 deletions
@@ -13,6 +13,7 @@ an Erlang-based build tool, including but not limited to the following: * You want a very fast compilation and test cycle * You want the full power of Unix at your disposal when hooking into your build tool + * You want to be able to easily edit the damn build tool and fix it when it fails * You want to use the deps mechanism with non-Erlang Makefile-based projects * Your project will be part of a larger make or automake based environment @@ -254,7 +255,7 @@ The following targets are specific to packages: `pkg-list` lists all packages in the index. -`pkg-search n=STRING` searches the index for STRING. +`pkg-search q=STRING` searches the index for STRING. Packages are downloaded into `DEPS_DIR` (`./deps/` by default). @@ -473,10 +474,9 @@ the test directory specified in `TEST_DIR`. `EUNIT_OPTS` can be used to specify EUnit-specific options (e.g. `verbose`) that will be used when calling -`eunit:test/2`. This configuration parameter defaults to -`verbose`. Note -that EUnit options are specified as a comma-separated -list of options. +`eunit:test/2`. This configuration parameter is empty +by default.. Note that EUnit options are specified as +a comma-separated list of options. Relx plugin ----------- @@ -538,6 +538,19 @@ Or: $ make triq t=cow_http_hd:prop_parse_accept ``` +Xref plugin +------------ + +This plugin is available by default. It adds the following +target: + +`xref` Erlang Xref Runner (inspired in rebar's rebar_xref) + +The `XREF_CONFIG` variable specifies the location of the +configuration file which holds the checks to be applied. +If there is no `xref.config` all `xref` checks will be +applied to the binaries located in the `/ebin` directory. + Contributing ------------ @@ -565,8 +578,7 @@ You can submit as many packages as you want in one pull request as long as you follow the instructions above. For patches or plugins, you have to edit the `core/*.mk` -or `plugins/*.mk` files and then run `make` to create an -updated `erlang.mk`. If you submit a new plugin, you also +or `plugins/*.mk` files. If you submit a new plugin, you also need to add it to the `build.config` file. Make sure to keep the commit title short, to have a single |