From 4aaeca15248b71c20f5aa8f17e0aa218e542f7f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Tue, 5 Nov 2024 14:03:28 +0100
Subject: [PATCH] Update user guide

---
 guide/getting_started.html | 5 ++++-
 guide/installation.html    | 4 ++--
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/guide/getting_started.html b/guide/getting_started.html
index 151a31a6f..ecb66d072 100644
--- a/guide/getting_started.html
+++ b/guide/getting_started.html
@@ -35,7 +35,10 @@
 
 <div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="installation.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="overview.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="getting_started"></a>Chapter 2. Getting started</h1></div></div></div><p>This chapter explains how to get started using Erlang.mk.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_creating_a_folder_for_your_project"></a>2.1. Creating a folder for your project</h2></div></div></div><p>The first step is always to create a new folder that will
 contain your project.</p><pre class="programlisting">$ mkdir hello_joe
-$ cd hello_joe</pre><p>Most people tend to put all their projects side by side in
+$ cd hello_joe</pre><p>Note that the project directory name must match the name of
+your application for some of the functionality to work (such
+as OTP releases). The name should only include letters, numbers
+or underscore as well for better compatibility.</p><p>Most people tend to put all their projects side by side in
 a common folder. We recommend keeping an organization similar
 to your remote repositories. For example, for GitHub users,
 put all your projects in a common folder with the same name
diff --git a/guide/installation.html b/guide/installation.html
index 2dd2962d5..226b094fd 100644
--- a/guide/installation.html
+++ b/guide/installation.html
@@ -64,11 +64,11 @@
 adequately.</p></div><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
 provides binaries of Erlang/OTP for all major and minor releases,
-available from the <a class="ulink" href="http://www.erlang.org/download.html" target="_top">official download page</a>.
+available from the <a class="ulink" href="https://www.erlang.org/downloads" target="_top">official download page</a>.
 It is recommended that you use the 64-bit installer unless
 technically impossible. Please follow the instructions from
 the installer to complete the installation.</p><p>The OTP team also provides a short guide to
-<a class="ulink" href="http://www.erlang.org/download.html" target="_top">installing Erlang/OTP on Windows</a>
+<a class="ulink" href="https://www.erlang.org/downloads" target="_top">installing Erlang/OTP on Windows</a>
 if you need additional references.</p><p>You can install Erlang/OTP silently using the <code class="literal">/S</code> switch
 on the command line:</p><pre class="screen">C:\Users\essen\Downloads&gt; otp_win64_18.0.exe /S</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_installing_msys2"></a>1.2.2. Installing MSYS2</h3></div></div></div><p>The only supported environment on Windows is MSYS2. MSYS2 is
 a lightweight Unix-like environment for Windows that comes