aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-11-05 16:21:57 +0200
committerLoïc Hoguin <[email protected]>2014-11-05 16:21:57 +0200
commit92626f1548c1dea677594c48040066ac2bb6f550 (patch)
tree520d1b089ac998ef7862ba563ed343d89351c7e5 /README.md
parent724f024bbffaa56dadb10ed88130831ed7e81b09 (diff)
downloaderlang.mk-92626f1548c1dea677594c48040066ac2bb6f550.tar.gz
erlang.mk-92626f1548c1dea677594c48040066ac2bb6f550.tar.bz2
erlang.mk-92626f1548c1dea677594c48040066ac2bb6f550.zip
Add an erlang-mk target for automated updating of 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 9672670..31f718b 100644
--- a/README.md
+++ b/README.md
@@ -219,6 +219,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
----------------