aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2024-01-23 14:08:06 +0100
committerLoïc Hoguin <[email protected]>2024-01-23 14:08:06 +0100
commit3e145af9b9e8d61ca042d1f94287d16b5ac155dd (patch)
tree852991cd66daf76f80e389f204bc05a5b3223550
parent427a276ef2f2042ad312e0260535cbb4696f9072 (diff)
downloadcowboy-3e145af9b9e8d61ca042d1f94287d16b5ac155dd.tar.gz
cowboy-3e145af9b9e8d61ca042d1f94287d16b5ac155dd.tar.bz2
cowboy-3e145af9b9e8d61ca042d1f94287d16b5ac155dd.zip
Getting started must include relx in deps
-rw-r--r--doc/src/guide/getting_started.asciidoc7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index 4bdde92..731e4a5 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -62,7 +62,7 @@ handler.
=== Cowboy setup
We will modify the 'Makefile' to tell the build system it needs to
-fetch and compile Cowboy:
+fetch and compile Cowboy, and that we will use releases:
[source,makefile]
----
@@ -71,6 +71,8 @@ PROJECT = hello_erlang
DEPS = cowboy
dep_cowboy_commit = 2.10.0
+REL_DEPS = relx
+
DEP_PLUGINS = cowboy
include erlang.mk
@@ -80,6 +82,9 @@ The `DEP_PLUGINS` line tells the build system to load the plugins
Cowboy provides. These include predefined templates that we will
use soon.
+The `REL_DEPS` line tells the build system to fetch and build
+`relx`, the library that will create the release.
+
If you do `make run` now, Cowboy will be included in the release
and started automatically. This is not enough however, as Cowboy
doesn't do anything by default. We still need to tell Cowboy to