From e5b8d638ea7293ae8a6d65386aefbb0d30aa254c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 28 Aug 2017 16:36:33 +0200 Subject: Update user guide --- guide/overview.html | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) (limited to 'guide/overview.html') diff --git a/guide/overview.html b/guide/overview.html index a449133..4e5743f 100644 --- a/guide/overview.html +++ b/guide/overview.html @@ -53,35 +53,35 @@ meant to be used for discovery purposes.

No package is ever installed, the and are always project-specific. They can be thought of as a shortcut over plain dependencies.

You can get a list of all packages known to Erlang.mk by using the search target:

$ make search

You can also use this target to search across all packages, for -example to find all packages related to Cowboy:

$ make search q=cowboy

3.3. Generating documentation

Erlang.mk supports EDoc and Asciidoc.

EDoc -Chapter 14, EDoc comments generates HTML documentation directly from +example to find all packages related to Cowboy:

$ make search q=cowboy

3.3. Generating documentation

Erlang.mk supports EDoc and Asciidoc.

EDoc +Chapter 15, EDoc comments generates HTML documentation directly from your source code.

While it is convenient, ask yourself: if all the documentation is inside the source code, why not just open the source code directly? -That’s where Asciidoc comes in.

The Asciidoc -Chapter 13, AsciiDoc documentation plugin expects all documentation +That’s where Asciidoc comes in.

The Asciidoc +Chapter 14, AsciiDoc documentation plugin expects all documentation to be separate from source. It will generate HTML, PDF, man pages and more from the documentation you write in the doc/src/ folder in your repository.

3.4. Running tests

Erlang.mk supports a lot of different testing and static -analysis tools.

The make shell -Chapter 15, Erlang shell command allows you +analysis tools.

The make shell +Chapter 16, Erlang shell command allows you to test your project manually. You can automate these -unit tests with EUnit -Chapter 16, EUnit and test -your entire system with Common Test -Chapter 17, Common Test. -Code coverage -Chapter 18, Code coverage can of course +unit tests with EUnit +Chapter 17, EUnit and test +your entire system with Common Test +Chapter 18, Common Test. +Code coverage +Chapter 19, Code coverage can of course be enabled during tests.

Erlang.mk comes with features to make your life easier when -setting up and using Continuous integration -Chapter 19, Continuous integration.

On the static analysis side of things, Erlang.mk comes with -support for Dialyzer -Chapter 20, Dialyzer and Xref -Chapter 21, Xref, +setting up and using Continuous integration +Chapter 20, Continuous integration.

On the static analysis side of things, Erlang.mk comes with +support for Dialyzer +Chapter 21, Dialyzer and Xref +Chapter 22, Xref, to perform success typing analysis and cross referencing -of the code.

3.5. Need more?

Not convinced yet? You can read about why you should use Erlang.mk -Chapter 24, Why Erlang.mk -and its history -Chapter 25, Short history. And if you’re still not +of the code.

3.5. Need more?

Not convinced yet? You can read about why you should use Erlang.mk +Chapter 25, Why Erlang.mk +and its history +Chapter 26, Short history. And if you’re still not convinced after that, it’s OK! The world would be boring if everyone agreed on everything all the time.

Prev   Next
 Home 
-- cgit v1.2.3