#################
Build from source
#################

Requirements
============

* `Git <http://git-scm.com/>`_

Get source
==========

Read-only::

	git clone git://swfm.git.sourceforge.net/gitroot/swfm/backend-php

.. note::

	For read/write access check the `develop page on Sourceforge
	<https://sourceforge.net/projects/swfm/develop>`_.

Build
=====

There isn't really any build process, because you can just copy the files
inside **src/** directly to the web server.

Build archive
=============

You are able to build to different versions of archives, on the one side
releases and on the other so called snapshots.

Release
-------

The following command will create new archives in the 'dist/' directory,
where *<the version>* have to be a valid git commit identifier (i.e. HEAD,
*tags*, *short/long commit hash*, ...)
::

	make archive ARCHIVE_VERSION=<the version>

For example::

	make archive ARCHIVE_VERSION=0.4
	make archive ARCHIVE_VERSION=ed7365344fe57f8015acdb15af542636d58aee49
	make archive ARCHIVE_VERSION=ed73653

Snapshot
--------

For a snapshot the current status of the repository is used
(ARCHIVE_VERSION=HEAD).

::

	make archive

Build documentation
===================

.. note::

	Till version 0.5 doxygen is used as documentation tool. Maybe this changes to `Sphinx <http://sphinx.pocoo.org/>`_ too.

::

		make apidoc