From 1a6311a3a4933e767ba057780cefe1600f50f5c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 7 Dec 2018 14:45:07 +0100 Subject: Update user guide --- guide/overview.html | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'guide/overview.html') diff --git a/guide/overview.html b/guide/overview.html index 87768e4..c78efdc 100644 --- a/guide/overview.html +++ b/guide/overview.html @@ -47,24 +47,24 @@ 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 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 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 plugin expects all documentation +That’s where Asciidoc comes in.

The Asciidoc 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 command allows you +analysis tools.

The make shell command allows you to test your project manually. You can automate these -unit tests with EUnit and test -your entire system with Common Test. -Code coverage can of course +unit tests with EUnit and test +your entire system with Common Test. +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.

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

On the static analysis side of things, Erlang.mk comes with +support for Dialyzer and 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 -and its 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 +and its 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