diff options
| author | Yun Seong Kim <[email protected]> | 2023-07-07 09:28:29 +0900 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2024-11-05 14:02:01 +0100 |
| commit | d3485e7eb64e16a1b482208bd1d7be24bfa58c43 (patch) | |
| tree | 4b13e316618ae973540ed0e30df27c824333df41 | |
| parent | 86e8f532f6db0125994a574393d2c5987f70e654 (diff) | |
| download | erlang.mk-d3485e7eb64e16a1b482208bd1d7be24bfa58c43.tar.gz erlang.mk-d3485e7eb64e16a1b482208bd1d7be24bfa58c43.tar.bz2 erlang.mk-d3485e7eb64e16a1b482208bd1d7be24bfa58c43.zip | |
Clarify project naming in getting started
LH: Expanded on the initial suggestion.
Signed-off-by: Yun Seong Kim <[email protected]>
| -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, |