Erlang Ant Library Files

===================================
===================================
   Erlang Ant Library
===================================
===================================

1. About:

Erlang Ant Library is Ant library containing tasks usefull for automation in developing software in Erlang programming language, especially when using IDE's such as Eclipse.

2. Prerequisitions:

For proper use Erlang Ant Library requires to following tools have been installed:
- Apache Ant 1.7+
- Erlang compiler

additionally erlang compiller must be available through erlc command.


3. Installation instructions:

Place ant library erlang_antlib_0.1.jar into some directory. Hereafter this directory will be called ERLANG_ANTLIB_DIR.

In your build.xml file import tasks from Erlang Ant Library:
  <typedef
    resource="antlib.xml"
    classpath="ERLANG_ANTLIB_DIR/erlang_antlib_0.1.jar"/>

and use the erlc tasks as described in the Documentation section.



4. Features:

Currently library contains 1 task - erlc.


5. Documentation:

5.1  Erlc

5.1.1 Description
-----------------
Task allowing compilation of Erlang source files to compilet beam.

5.1.2 Parameters
----------------

 ---------------------------------------------------------------
 | Attribute | Description                          | Required |
 ---------------------------------------------------------------
 | outputdir | directory to store compiled          | No       |
 |           | beam files                           |          |
 ---------------------------------------------------------------

Parameters specified as nested elements

5.1.2.1 fileset

 Fileset containing files for compilation

5.1.3 Example:
--------------
  <erlc outputdir="${bin.dir}">
    <fileset dir="${src.dir}" />
  </erlc>


6. License: GNU Library or Lesser General Public License (LGPL)

7. Version: 0.1

8. Official website: http://sourceforge.net/projects/erlangantlib/

9. Authors:
Piotr "Piter" Paradzinski