aboutsummaryrefslogtreecommitdiffstats
path: root/guide/installation.html
diff options
context:
space:
mode:
Diffstat (limited to 'guide/installation.html')
-rw-r--r--guide/installation.html22
1 files changed, 16 insertions, 6 deletions
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}
</header>
<main>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="getting_started.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="installation"></a>Chapter 1. Installation</h1></div></div></div><p>This chapter explains how to setup your system in
-order to use Erlang.mk.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_on_unix"></a>1.1. On Unix</h2></div></div></div><p>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.</p><p>Some functionality requires that Autoconf 2.59 or later be
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="getting_started.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="installation"></a>Chapter 1. Installation</h1></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_on_unix"></a>1.1. On Unix</h2></div></div></div><p>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.</p><p>Git and Erlang/OTP must also be installed.</p><p>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.</p><p>Erlang.mk currently requires Erlang/OTP to be installed in
-order to compile Erlang projects.</p><p>Some packages may require additional libraries.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_on_windows"></a>1.2. On Windows</h2></div></div></div><p>Erlang.mk can be used on Windows inside an MSYS2 environment.
+have further requirements depending on your needs.</p><p>Some packages may require additional libraries.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_linux"></a>1.1.1. Linux</h3></div></div></div><p>The commands to install packages vary between distributions:</p><p><strong>Arch Linux. </strong>
+</p><pre class="programlisting">$ pacman -Sy erlang git make</pre><p>
+</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_freebsd"></a>1.1.2. FreeBSD</h3></div></div></div><p>FreeBSD comes with binary and source packages:</p><p><strong>Install binary packages. </strong>
+</p><pre class="programlisting">$ pkg install erl git gmake</pre><p>
+</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_os_x_and_macos"></a>1.1.3. OS X and macOS</h3></div></div></div><p>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:</p><p><strong>Homebrew. </strong>
+</p><pre class="programlisting">$ brew install erlang git homebrew/dupes/make</pre><p>
+</p><p><strong>MacPorts. </strong>
+</p><pre class="programlisting">$ sudo port install erlang git gmake</pre><p>
+</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_on_windows"></a>1.2. On Windows</h2></div></div></div><p>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.</p><p>The rest of this section details how to setup Erlang/OTP and
MSYS2 in order to use Erlang.mk.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_installing_erlang_otp"></a>1.2.1. Installing Erlang/OTP</h3></div></div></div><p>Erlang.mk requires Erlang/OTP to be installed. The OTP team