From d3485e7eb64e16a1b482208bd1d7be24bfa58c43 Mon Sep 17 00:00:00 2001
From: Yun Seong Kim <yunseong.kim@ericsson.com>
Date: Fri, 7 Jul 2023 09:28:29 +0900
Subject: Clarify project naming in getting started

LH: Expanded on the initial suggestion.

Signed-off-by: Yun Seong Kim <yunseong.kim@ericsson.com>
---
 doc/src/guide/getting_started.asciidoc | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'doc/src/guide/getting_started.asciidoc')

diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index be58e87..7a4a114 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -12,6 +12,11 @@ contain your project.
 $ mkdir hello_joe
 $ cd hello_joe
 
+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.
+
 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,
-- 
cgit v1.2.3

