From 1e209c658e768911a27fbed8f996e99e8b68f320 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 21 Apr 2020 13:39:21 +0200 Subject: Update user guide --- guide/getting_started.html | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'guide/getting_started.html') 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 $HOME/ninenines/cowboy for the Cowboy project.

2.2. Downloading Erlang.mk

At the time of writing, Erlang.mk is unlikely to be present -in your Erlang distribution, or even in your OS packages.

The next step is therefore to download it:

$ wget https://erlang.mk/erlang.mk

Or:

$ curl -O https://erlang.mk/erlang.mk

Alternatively, just click on this link.

Make sure you put the file inside the folder we created previously.

2.3. Getting started with OTP applications

An OTP application is an Erlang application that has a supervision +in your Erlang distribution, or even in your OS packages.

The next step is therefore to download it:

$ wget https://erlang.mk/erlang.mk

Or:

$ curl -O https://erlang.mk/erlang.mk

Alternatively, just click on this link.

Make sure you put the file inside the folder we created previously.

2.2.1. Bash completion

If your preferred shell is Bash, a completion script is available. +In order to install it, use the following commands:

$ mkdir ~/.bash_completion.d/
+$ cd ~/.bash_completion.d/
+$ wget -O erlang_mk https://raw.githubusercontent.com/ninenines/erlang.mk/master/etc/bash_completion

Then edit the file ~/.bash_completion and add:

for bcfile in ~/.bash_completion.d/* ; do
+    . $bcfile
+done

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.

2.3. Getting started with OTP applications

An OTP application is an Erlang application that has a supervision tree. In other words, it will always have processes running.

This kind of project can be automatically generated by Erlang.mk. All you need to do is use the bootstrap target:

$ make -f erlang.mk bootstrap

Something similar to the following snippet will then appear on your screen:

git clone https://github.com/ninenines/erlang.mk .erlang.mk.build
-- 
cgit v1.2.3