aboutsummaryrefslogtreecommitdiffstats
path: root/guide/getting_started.html
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2020-04-21 13:39:21 +0200
committerLoïc Hoguin <[email protected]>2020-04-21 13:39:21 +0200
commit1e209c658e768911a27fbed8f996e99e8b68f320 (patch)
treedfe93ba9db0447ebe82d4e1a8c7f13fd1cd15b07 /guide/getting_started.html
parent374933627a1de6d5a4a8ea68c65ec8624388ea8e (diff)
downloaderlang.mk-1e209c658e768911a27fbed8f996e99e8b68f320.tar.gz
erlang.mk-1e209c658e768911a27fbed8f996e99e8b68f320.tar.bz2
erlang.mk-1e209c658e768911a27fbed8f996e99e8b68f320.zip
Update user guide
Diffstat (limited to 'guide/getting_started.html')
-rw-r--r--guide/getting_started.html9
1 files changed, 8 insertions, 1 deletions
diff --git a/guide/getting_started.html b/guide/getting_started.html
index d779c71..151a31a 100644
--- a/guide/getting_started.html
+++ b/guide/getting_started.html
@@ -41,7 +41,14 @@ to your remote repositories. For example, for GitHub users,
put all your projects in a common folder with the same name
as your username. For example <span class="emphasis"><em>$HOME/ninenines/cowboy</em></span> for
the Cowboy project.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_downloading_erlang_mk"></a>2.2. Downloading Erlang.mk</h2></div></div></div><p>At the time of writing, Erlang.mk is unlikely to be present
-in your Erlang distribution, or even in your OS packages.</p><p>The next step is therefore to download it:</p><pre class="programlisting">$ wget https://erlang.mk/erlang.mk</pre><p>Or:</p><pre class="programlisting">$ curl -O https://erlang.mk/erlang.mk</pre><p>Alternatively, just <a class="ulink" href="https://erlang.mk/erlang.mk" target="_top">click on this link</a>.</p><p>Make sure you put the file inside the folder we created previously.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_getting_started_with_otp_applications"></a>2.3. Getting started with OTP applications</h2></div></div></div><p>An OTP application is an Erlang application that has a supervision
+in your Erlang distribution, or even in your OS packages.</p><p>The next step is therefore to download it:</p><pre class="programlisting">$ wget https://erlang.mk/erlang.mk</pre><p>Or:</p><pre class="programlisting">$ curl -O https://erlang.mk/erlang.mk</pre><p>Alternatively, just <a class="ulink" href="https://erlang.mk/erlang.mk" target="_top">click on this link</a>.</p><p>Make sure you put the file inside the folder we created previously.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_bash_completion"></a>2.2.1. Bash completion</h3></div></div></div><p>If your preferred shell is Bash, a completion script is available.
+In order to install it, use the following commands:</p><pre class="programlisting">$ mkdir ~/.bash_completion.d/
+$ cd ~/.bash_completion.d/
+$ wget -O erlang_mk https://raw.githubusercontent.com/ninenines/erlang.mk/master/etc/bash_completion</pre><p>Then edit the file <code class="literal">~/.bash_completion</code> and add:</p><pre class="programlisting">for bcfile in ~/.bash_completion.d/* ; do
+ . $bcfile
+done</pre><p>Note that Make’s legacy Bash completion will be overwritten.
+If you need legacy completion for other C projects, consider sourcing
+Erlang.mk’s Bash completion only in your Erlang project directory instead.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_getting_started_with_otp_applications"></a>2.3. Getting started with OTP applications</h2></div></div></div><p>An OTP application is an Erlang application that has a supervision
tree. In other words, it will always have processes running.</p><p>This kind of project can be automatically generated by Erlang.mk.
All you need to do is use the <code class="literal">bootstrap</code> target:</p><pre class="programlisting">$ make -f erlang.mk bootstrap</pre><p>Something similar to the following snippet will then appear
on your screen:</p><pre class="programlisting">git clone https://github.com/ninenines/erlang.mk .erlang.mk.build