From 1393f77c8442a0b89a0ec1838a59114937fd50b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 21 Oct 2016 14:49:06 +0200 Subject: Update user guide --- guide/installation.html | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) (limited to 'guide/installation.html') diff --git a/guide/installation.html b/guide/installation.html index 7749886..bc5efb3 100644 --- a/guide/installation.html +++ b/guide/installation.html @@ -33,13 +33,23 @@ div.navfooter{margin-bottom:1em}
-

Chapter 1. Installation

This chapter explains how to setup your system in -order to use Erlang.mk.

1.1. On Unix

Erlang.mk requires GNU Make to be installed. GNU Make 3.81 -or later is required. GNU Make 4.1 or later is recommended, -as this is the version Erlang.mk is developed on.

Some functionality requires that Autoconf 2.59 or later be +

Chapter 1. Installation

1.1. On Unix

Erlang.mk requires GNU Make to be installed. While it will +currently work with GNU Make 3.81, support for this version +is deprecated and will be removed in 2017. We recommend +GNU Make 4.1 or later.

Git and Erlang/OTP must also be installed.

Some functionality requires that Autoconf 2.59 or later be installed, in order to compile Erlang/OTP. Erlang/OTP may -have further requirements depending on your needs.

Erlang.mk currently requires Erlang/OTP to be installed in -order to compile Erlang projects.

Some packages may require additional libraries.

1.2. On Windows

Erlang.mk can be used on Windows inside an MSYS2 environment. +have further requirements depending on your needs.

Some packages may require additional libraries.

1.1.1. Linux

The commands to install packages vary between distributions:

Arch Linux.  +

$ pacman -Sy erlang git make

+

1.1.2. FreeBSD

FreeBSD comes with binary and source packages:

Install binary packages.  +

$ pkg install erl git gmake

+

1.1.3. OS X and macOS

While Apple distributes their own GNU Make, their version is +very old and plagued with numerous bugs. It is recommended +to install a more recent version from either Homebrew or +MacPorts:

Homebrew.  +

$ brew install erlang git homebrew/dupes/make

+

MacPorts.  +

$ sudo port install erlang git gmake

+

1.2. On Windows

Erlang.mk can be used on Windows inside an MSYS2 environment. Cygwin, MSYS (the original) and native Windows (both Batch and PowerShell) are currently not supported.

The rest of this section details how to setup Erlang/OTP and MSYS2 in order to use Erlang.mk.

1.2.1. Installing Erlang/OTP

Erlang.mk requires Erlang/OTP to be installed. The OTP team -- cgit v1.2.3