diff options
author | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
commit | 92b54aacc0de5446dd5497c39897b0bbff72e626 (patch) | |
tree | c3a98cfec636d1271f5804e5c19b35b208bba00d /docs/en/erlang.mk/1/guide/overview | |
parent | 8b5c3dc972b99f174750123c9e4abc96259c34a9 (diff) | |
download | ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.gz ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.bz2 ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.zip |
Rebuild using Asciideck
Diffstat (limited to 'docs/en/erlang.mk/1/guide/overview')
-rw-r--r-- | docs/en/erlang.mk/1/guide/overview/index.html | 102 |
1 files changed, 25 insertions, 77 deletions
diff --git a/docs/en/erlang.mk/1/guide/overview/index.html b/docs/en/erlang.mk/1/guide/overview/index.html index 1a4b2b9d..9fa002de 100644 --- a/docs/en/erlang.mk/1/guide/overview/index.html +++ b/docs/en/erlang.mk/1/guide/overview/index.html @@ -62,94 +62,42 @@ <h1 class="lined-header"><span>Overview</span></h1> -<div class="paragraph"><p>Now that you know how to get started, let’s take a look at -what Erlang.mk can do for you.</p></div> -<div class="sect1"> +<p>Now that you know how to get started, let's take a look at what Erlang.mk can do for you.</p> <h2 id="_building_your_project">Building your project</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Erlang.mk is first and foremost a build tool. It is especially -tailored for Erlang developers and follows widely accepted -practices in the Erlang community.</p></div> -<div class="paragraph"><p>Erlang.mk will happily build all <a href="../building">Erlang-specific files</a> -you throw at it. Other kinds of files too, like C or C++ code -when you are working on <a href="../ports">a NIF or a port driver</a>.</p></div> -<div class="paragraph"><p>Erlang.mk embraces the concept of <a href="../deps">source dependencies</a>. -It can fetch dependency source code using a variety of mechanisms, -including fetching from Git, Mercurial or SVN.</p></div> -<div class="paragraph"><p>Erlang.mk will automatically <a href="../relx">generate releases</a> -when applicable. It can also <a href="../escript">generate escripts</a>.</p></div> -</div> -</div> -<div class="sect1"> +<p>Erlang.mk is first and foremost a build tool. It is especially tailored for Erlang developers and follows widely accepted practices in the Erlang community.</p> +<p>Erlang.mk will happily build all <a href="../building">Erlang-specific files</a> you throw at it. Other kinds of files too, like C or C++ code when you are working on <a href="../ports">a NIF or a port driver</a>.</p> +<p>Erlang.mk embraces the concept of <a href="../deps">source dependencies</a>. It can fetch dependency source code using a variety of mechanisms, including fetching from Git, Mercurial or SVN.</p> +<p>Erlang.mk will automatically <a href="../relx">generate releases</a> when applicable. It can also <a href="../escript">generate escripts</a>.</p> <h2 id="_exploring_the_package_index">Exploring the package index</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Erlang.mk comes with a <a href="../deps">built-in package index</a>. -It is built as an extension of the dependency system and is -meant to be used for discovery purposes.</p></div> -<div class="paragraph"><p>No package is ever installed, they are only used as dependencies -and are always project-specific. They can be thought of as a -shortcut over plain dependencies.</p></div> -<div class="paragraph"><p>You can get a list of all packages known to Erlang.mk by using -the <code>search</code> target:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>Erlang.mk comes with a <a href="../deps">built-in package index</a>. It is built as an extension of the dependency system and is meant to be used for discovery purposes.</p> +<p>No package is ever installed, they are only used as dependencies and are always project-specific. They can be thought of as a shortcut over plain dependencies.</p> +<p>You can get a list of all packages known to Erlang.mk by using the <code>search</code> target:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make search</tt></pre></div></div> -<div class="paragraph"><p>You can also use this target to search across all packages, for -example to find all packages related to Cowboy:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make search</tt></pre> +</div></div> +<p>You can also use this target to search across all packages, for example to find all packages related to Cowboy:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make search <span style="color: #009900">q</span><span style="color: #990000">=</span>cowboy</tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>$ make search <font color="#009900">q</font><font color="#990000">=</font>cowboy</tt></pre> +</div></div> <h2 id="_generating_documentation">Generating documentation</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Erlang.mk supports <em>EDoc</em> and <em>Asciidoc</em>.</p></div> -<div class="paragraph"><p><a href="../edoc">EDoc</a> generates HTML documentation directly from -your source code.</p></div> -<div class="paragraph"><p>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 <em>Asciidoc</em> comes in.</p></div> -<div class="paragraph"><p>The <a href="../asciidoc">Asciidoc</a> 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 <em>doc/src/</em> folder in -your repository.</p></div> -</div> -</div> -<div class="sect1"> +<p>Erlang.mk supports <em>EDoc</em> and <em>Asciidoc</em>.</p> +<p><a href="../edoc">EDoc</a> generates HTML documentation directly from your source code.</p> +<p>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 <em>Asciidoc</em> comes in.</p> +<p>The <a href="../asciidoc">Asciidoc</a> 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 <em>doc/src/</em> folder in your repository.</p> <h2 id="_running_tests">Running tests</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Erlang.mk supports a lot of different testing and static -analysis tools.</p></div> -<div class="paragraph"><p>The <a href="../shell">make shell</a> command allows you -to test your project manually. You can automate these -unit tests with <a href="../eunit">EUnit</a> and test -your entire system with <a href="../ct">Common Test</a>. -<a href="../coverage">Code coverage</a> can of course -be enabled during tests.</p></div> -<div class="paragraph"><p>Erlang.mk comes with features to make your life easier when -setting up and using <a href="../ci">Continuous integration</a>.</p></div> -<div class="paragraph"><p>On the static analysis side of things, Erlang.mk comes with -support for <a href="../dialyzer">Dialyzer</a> and <a href="#xref">Xref</a>, -to perform success typing analysis and cross referencing -of the code.</p></div> -</div> -</div> -<div class="sect1"> +<p>Erlang.mk supports a lot of different testing and static analysis tools.</p> +<p>The <a href="../shell">make shell</a> command allows you to test your project manually. You can automate these unit tests with <a href="../eunit">EUnit</a> and test your entire system with <a href="../ct">Common Test</a>. <a href="../coverage">Code coverage</a> can of course be enabled during tests.</p> +<p>Erlang.mk comes with features to make your life easier when setting up and using <a href="../ci">Continuous integration</a>.</p> +<p>On the static analysis side of things, Erlang.mk comes with support for <a href="../dialyzer">Dialyzer</a> and <a href="../xref">Xref</a>, to perform success typing analysis and cross referencing of the code.</p> <h2 id="_need_more">Need more?</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Not convinced yet? You can read about <a href="../why">why you should use Erlang.mk</a> -and its <a href="../history">history</a>. 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.</p></div> -</div> -</div> +<p>Not convinced yet? You can read about <a href="../why">why you should use Erlang.mk</a> and its <a href="../history">history</a>. 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.</p> + |