README (english)
--------------------------------
Developper guide
--------------------------------


***** Doxygen documentation

Doxygen documentation for Dolibarr source code can be generated by running
the script:
> perl dolybarr-doxygen-build.pl

Prerequite is only having Doxygen installed (Linux or Windows).


***** Build a patch

To build a patch between two directories, you can use the following diff command:
diff -Naur --exclude=CVS --exclude=.#  --exclude=~ --exclude=documents --exclude=phplot5 --exclude=phplot --exclude=scriptaculous --exclude=treemenu --exclude *.htm --exclude samples dolibarr_old dolibarr_new > mydiff.patch


***** Build a release

This is all steps required to build a release od Dolibarr x.x:
* Check there is no more major bug reports, nor running developments.
* Run a CVS update.
* Update the ChangeLog file.
* Check that file build/tgz/tar.exclude excludes all non expected files.
* Run script build/dolibarr_mysql2pgsql.pl and commit/add new files.
* Update and commit file htdocs/master.inc.php to include new version constant.
* Update and commit file doc/dev/dolibarr-doxygen.conf to include new version constants.
* Update and commit file build/makepack-dolibarr.pl to include new version constants.
* Check all CVS commits are done.
* Run script makepack-dolibarr.pl
* Tagg CVS with tag DOLIBARR_x_x_BETA or DOLIBARR_x_x for a release with option "overwrite tags if exists"
* Upload script to Dolibarr web site
* Add a news on Dolibarr Web site
* Create a branch for version x.x


***** Other developper documentation

More information is available on Dolibarr web site:
> http://www.dolibarr.org/
