diff options
Diffstat (limited to 'doc/src/guide/getting_started.asciidoc')
| -rw-r--r-- | doc/src/guide/getting_started.asciidoc | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc index be58e87..904cd7d 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, @@ -266,8 +271,20 @@ You can list all available templates with the `list-templates` target: [source,bash] +---- $ make list-templates -Available templates: cowboy_http cowboy_loop cowboy_rest cowboy_ws gen_fsm gen_server gen_statem ranch_protocol supervisor +Available templates: + cowboy_http_h + cowboy_loop_h + cowboy_rest_h + cowboy_websocket_h + gen_fsm + gen_server + gen_statem + module + ranch_protocol + supervisor +---- To generate a module, let's say a `gen_server`, all you need to do is to call `make new` with the appropriate arguments: @@ -345,7 +362,8 @@ Bootstrap targets: This guide should provide any other answer. If not, please open a ticket on https://github.com/ninenines/erlang.mk/issues[the official repository] -and we will work on improving the guide. +and we will work on improving the guide. For any other questions, +please visit the https://discord.gg/x25nNq2fFE[Erlang OSS Discord server]. Commercial support is available through Nine Nines. Please contact Loïc Hoguin by sending an email to mailto:[email protected][]. |