A download manager component for Joomla!, designed for software distribution

In order to build the installation packages of this component you need to have the following tools:

• A command line environment. bash under Linux / Mac OS X works best. On Windows you will need to run most tools using an elevated privileges (administrator) command prompt.
• The PHP CLI binary in your path
• Command line Git binaries(*)
• PEAR and Phing installed, with the Net_FTP and VersionControl_SVN PEAR packages installed
• libxml and libxslt tools if you intend to build the documentation PDF files

You will also need the following path structure on your system

• ars This repository, a.k.a. MAIN directory
• buildfiles Akeeba Build Tools (https://github.com/akeeba/buildfiles)
• fof FOF framework (https://github.com/akeeba/fof)

You will need to use the exact folder names specified here.

All of the following commands are to be run from the MAIN directory. Lines starting with $ indicate a Mac OS X / Linux / other *NIX system commands. Lines starting with > indicate Windows commands. The starting character ($ or >) MUST NOT be typed!

1. You will first need to do the initial link with Akeeba Build Tools, running the following command (Mac OS X, Linux, other *NIX systems):

    $ php ../buildfiles/tools/link.php `pwd`
   

   or, on Windows:

    > php ../buildfiles/tools/link.php %CD%
   

2. After the initial linking takes place, go inside the build directory:

    $ cd build
   

   and run the link phing task:

    $ phing link
   

All of the following commands are to be run from the MAIN/build directory. Lines starting with $ indicate a Mac OS X / Linux / other *NIX system commands. Lines starting with > indicate Windows commands. The starting character ($ or >) MUST NOT be typed!

You are advised to NOT distribute the library installation packages you have built yourselves with your components. It is best to only use the official library packages released by Akeeba Ltd.

1. Relinking internal files

   This is only required when the buildfiles change.

    $ phing link
    > phing link
   

2. Creating a dev release installation package

   This creates the installable ZIP packages of the component inside the MAIN/release directory.

    $ phing git
    > phing git
   

   WARNING Do not distribute the dev releases to your clients. Dev releases, unlike regular releases, also use a dev version of FOF 3.

3. Build the documentation in PDF format

   This creates the documentation in PDF format

    $ phing doc-j-pdf
    > phing doc-j-pdf
   

Please note that all generated files (ZIP library packages, PDF files, HTML files) are written to the release directory inside the repository's root.