diff options
| author | Loïc Hoguin <[email protected]> | 2024-01-23 13:43:10 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2024-01-23 13:43:10 +0100 |
| commit | 43533ac6bc2112beaa229bbb3fe5cd73a116ecda (patch) | |
| tree | dacc40d04c3f5bb61c279063ffe709154e6d2b32 | |
| parent | bb811a86a870009b5999304db2025fd07053e638 (diff) | |
| download | erlang.mk-43533ac6bc2112beaa229bbb3fe5cd73a116ecda.tar.gz erlang.mk-43533ac6bc2112beaa229bbb3fe5cd73a116ecda.tar.bz2 erlang.mk-43533ac6bc2112beaa229bbb3fe5cd73a116ecda.zip | |
Update instructions for releases
| -rw-r--r-- | doc/src/guide/releases.asciidoc | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/doc/src/guide/releases.asciidoc b/doc/src/guide/releases.asciidoc index 892e341..a3bdb10 100644 --- a/doc/src/guide/releases.asciidoc +++ b/doc/src/guide/releases.asciidoc @@ -7,8 +7,15 @@ https://erlware.github.io/relx/[Relx website] for more information. === Setup -Erlang.mk will create a release if it detects a Relx configuration -file in the '$(RELX_CONFIG)' location. This defaults to +First, `relx` must be added in the dependencies of your +project. You can add it to `REL_DEPS` so that it is fetched +whenever you need to build the release: + +[source,erlang] +REL_DEPS = relx + +Then, you need to create a 'relx.config' file in the +'$(RELX_CONFIG)' location. This defaults to '$(CURDIR)/relx.config'. You can override it by defining the variable before including Erlang.mk: @@ -29,14 +36,6 @@ RELX_CONFIG = $(CURDIR)/relx.dev.config endif ---- -Relx does not need to be installed. Erlang.mk will download -and build it automatically. - -The Relx executable will be saved in the '$(RELX)' file. This -location defaults to '$(CURDIR)/relx' and can be overridden. - -// @todo You can use a custom location by ??? - === Configuration You can specify additional Relx options using the `RELX_OPTS` |