README (English)

Path: /dolibarr/dev/build/README

##################################################
Building packages
##################################################

All sub-directories of "build" directory contains files (setup or binary tools) required to build automatically Dolibarr packages.
The build directory and all its contents is absolutely not required to make Dolibarr working.
It is here only to build Dolibarr packages, and those generated packages will not contains this "build" directory.


There are several tools:

--------------------------------------------------------------------------------------------------

- To build full Dolibarr packages, launch the script
> Launch command perl makepack-dolibarr.pl

See makepack-howto.txt for prerequisites.

--------------------------------------------------------------------------------------------------

- To build a theme package, launch the script
> perl makepack-dolibarrtheme.pl


--------------------------------------------------------------------------------------------------

- To build a package for a module, launch the script
> perl makepack-dolibarrmodule.pl


--------------------------------------------------------------------------------------------------

- To build developer documentation, launch the script
> perl dolibarr-doxygen-build.pl


--------------------------------------------------------------------------------------------------


You can find in "build", following sub-directories:

* composer
To test an upgrade of a lib.

* debian
To build Debian package.

* dmg:
To build Mac OS package (not ready yet).

* doap:
To build Doap descriptor to promote/describe Dolibarr releases.

* docker:
To deploy Dolibarr with docker.

* doxygen:
Dir with config file to build doxygen documentation.

* exe:
To build exe package for Windows that distribute Dolibarr sources or
to build the complete DoliWamp package.

* gource:
To build the video of history of git changes.

* launchpad:
Doc file to explain how to use launchpad.

* obs:
Doc file to explain how to push release onto OBS.

* pad:
To build a PAD file descriptor to promote/describe Dolibarr releases.

* patch:
Script file to generate a patch file to distribute a Dolibarr mod.

* perl:
Tool to install dolibarr when using virtualmin pro

* rpm:
To build Redhat, Opensuse or Mandriva package.

* tgz:
To build a tgz package.

* travis-ci:
Used by travis to make CI.

* zip:
To build a zip package.
