diff options
-rw-r--r-- | doc/src/guide/getting_started.asciidoc | 5 |
1 files changed, 5 insertions, 0 deletions
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, |