aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-09-11 17:48:39 +0200
committerLoïc Hoguin <[email protected]>2014-09-11 17:49:38 +0200
commitb8b9fffb39537f44c65b6272e268ea2c88a5be56 (patch)
treea1781e7bd0febf162d2e23aa2bcd9df2002c41f4 /README.md
parentdac7978f780bd5712d9589cb6fb7d913af84ddb9 (diff)
parent889f959855de39323802791d02d0164df21d0a2c (diff)
downloaderlang.mk-b8b9fffb39537f44c65b6272e268ea2c88a5be56.tar.gz
erlang.mk-b8b9fffb39537f44c65b6272e268ea2c88a5be56.tar.bz2
erlang.mk-b8b9fffb39537f44c65b6272e268ea2c88a5be56.zip
Merge branch 'master' of git://github.com/Version2beta/erlang.mk
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 793b790..6d6452e 100644
--- a/README.md
+++ b/README.md
@@ -328,6 +328,22 @@ If `RELX_OPTS` includes the `-o` option (instead of using
the list, otherwise erlang.mk will fail to find it and
will not be able to clean up the release directory.
+Shell plugin
+------------
+
+This plugin is available by default.
+
+`SHELL_DEPS` adds the specified modules only when `make shell`
+or `make build-shell-deps` is run. For example, to include a module
+reloader and TDD test runner, one might add `SHELL_DEPS = tddreloader`
+to the Makefile.
+
+You can add extra `erl` options by defining the `SHELL_OPTS` variable.
+For more information please see `erl -man erl`.
+
+`SHELL_PATH` adds paths to the shell's library search path. By default
+this option sets the paths to `-pa ../$(PROJECT)/ebin $(DEPS_DIR)/*/ebin`.
+
Contributing
------------