aboutsummaryrefslogtreecommitdiffstats
path: root/guide/getting_started.html
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-04 12:04:40 +0200
committerLoïc Hoguin <[email protected]>2018-06-04 12:04:40 +0200
commit4684b443bbe71bd9b7acd7a4b5aec5160031ae71 (patch)
tree164bee29e055c40a176b568b0076627602632266 /guide/getting_started.html
parent75a6ce5f30ab530b2f38ea06262cff0d3a78643a (diff)
downloaderlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.tar.gz
erlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.tar.bz2
erlang.mk-4684b443bbe71bd9b7acd7a4b5aec5160031ae71.zip
Update user guide
Diffstat (limited to 'guide/getting_started.html')
-rw-r--r--guide/getting_started.html7
1 files changed, 2 insertions, 5 deletions
diff --git a/guide/getting_started.html b/guide/getting_started.html
index 06b92cd..d779c71 100644
--- a/guide/getting_started.html
+++ b/guide/getting_started.html
@@ -62,8 +62,7 @@ cp .erlang.mk.build/erlang.mk ./erlang.mk
rm -rf .erlang.mk.build</pre><p>This is Erlang.mk bootstrapping itself. Indeed, the file you
initially downloaded contains nothing more than the code needed
to bootstrap. This operation is done only once. Consult the
-<a class="link" href="updating.html" title="Chapter 4. Updating Erlang.mk">Updating Erlang.mk</a>
-<a class="xref" href="updating.html" title="Chapter 4. Updating Erlang.mk">Chapter 4, <em>Updating Erlang.mk</em></a> chapter for more
+<a class="link" href="updating.html" title="Chapter 4. Updating Erlang.mk">Updating Erlang.mk</a> chapter for more
information.</p><p>Of course, the generated project can now be compiled:</p><pre class="programlisting">$ make</pre><p>Cheers!</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_getting_started_with_otp_libraries"></a>2.4. Getting started with OTP libraries</h2></div></div></div><p>An OTP library is an Erlang application that has no supervision
tree. In other words, it is nothing but modules.</p><p>This kind of project can also be generated by Erlang.mk, using
the <code class="literal">bootstrap-lib</code> target:</p><pre class="programlisting">$ make -f erlang.mk bootstrap-lib</pre><p>Erlang.mk will once again bootstrap itself and generate all
@@ -76,7 +75,6 @@ create a project that will build a release:</p><pre class="programlisting">$ mak
commands useful during operations, and put the components
of the system in separate applications that you will then
depend on. Consult the <a class="link" href="deps.html" title="Chapter 7. Packages and dependencies">Packages and dependencies</a>
-<a class="xref" href="deps.html" title="Chapter 7. Packages and dependencies">Chapter 7, <em>Packages and dependencies</em></a>
chapter for more information.</p><p>When you run <code class="literal">make</code> from now on, Erlang.mk will compile your
project and build the release:</p><pre class="programlisting">$ make
APP hello_joe.app.src
@@ -93,7 +91,6 @@ project and build the release:</p><pre class="programlisting">$ make
<span class="emphasis"><em>relx</em></span>, the release building tool. So don’t worry if you see
more output than above.</p><p>If building the release is slow, no need to upgrade your
hardware just yet. Just consult the <a class="link" href="relx.html" title="Chapter 9. Releases">Releases</a>
-<a class="xref" href="relx.html" title="Chapter 9. Releases">Chapter 9, <em>Releases</em></a>
chapter for various tips to speed up build time during
development.</p><p>You can start the release using the <span class="emphasis"><em>./_rel/hello_joe_release/bin/hello_joe_release</em></span>
script, or simply run <code class="literal">make run</code>. The latter will also compile
@@ -135,7 +132,7 @@ boilerplate. It is rarely an issue of course, except when
creating new modules. That’s why Erlang.mk not only comes with
templates for generating projects, but also individual modules!</p><p>You can list all available templates with the <code class="literal">list-templates</code>
target:</p><pre class="programlisting">$ make list-templates
-Available templates: cowboy_http cowboy_loop cowboy_rest cowboy_ws gen_fsm gen_server ranch_protocol supervisor</pre><p>To generate a module, let’s say a <code class="literal">gen_server</code>, all you need to
+Available templates: cowboy_http cowboy_loop cowboy_rest cowboy_ws gen_fsm gen_server gen_statem ranch_protocol supervisor</pre><p>To generate a module, let’s say a <code class="literal">gen_server</code>, all you need to
do is to call <code class="literal">make new</code> with the appropriate arguments:</p><pre class="programlisting">$ make new t=gen_server n=my_server</pre><p>This will create a module located in <span class="emphasis"><em>src/my_server.erl</em></span>
using the <code class="literal">gen_server</code> template.</p><p>This module is automatically compiled the next time you run
<code class="literal">make</code>:</p><pre class="programlisting">$ make