README 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. README (English)
  2. Path: /dolibarr/build/README
  3. ##################################################
  4. Building packages
  5. ##################################################
  6. All sub-directories of "build" directory contains files (setup or binary tools) required to build automatically Dolibarr packages.
  7. The build directory and all its contents is absolutely not required to make Dolibarr working.
  8. It is here only to build Dolibarr packages, and those generated packages will not contains this "build" directory.
  9. There are several tools:
  10. - To build full Dolibarr packages, launch the script
  11. > Launch command perl makepack-dolibarr.pl
  12. --------------------------------------------------------------------------------------------------
  13. Prerequisites to build tgz, debian and rpm packages:
  14. > apt-get install tar dpkg dpatch p7zip-full rpm zip
  15. --------------------------------------------------------------------------------------------------
  16. Prerequisites to build autoexe DoliWamp package:
  17. > apt-get install wine q4wine
  18. > Launch "wine cmd" to check a drive Z: pointing to / exists.
  19. > Install InnoSetup
  20. For example by running isetup-5.5.8.exe (https://www.jrsoftware.org) https://files.jrsoftware.org/is/5/
  21. > Install WampServer into "C:\wamp64" to have Apache, PHP and MariaDB
  22. For example by running wampserver3.2.0_x64.exe (https://www.wampserver.com).
  23. See file build/exe/doliwamp.iss to know the doliwamp version currently setup.
  24. > Add path to ISCC into PATH windows var:
  25. Launch wine cmd, then regedit and add entry int HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment\PATH
  26. > To build manually the .exe from Windows (running from makepack-dolibarr.pl script is however recommanded),
  27. open file build/exe/doliwamp.iss and click on button "Compile".
  28. The .exe file will be build into directory build.
  29. --------------------------------------------------------------------------------------------------
  30. - To build a theme package, launch the script
  31. > perl makepack-dolibarrtheme.pl
  32. --------------------------------------------------------------------------------------------------
  33. - To build a package for a module, launch the script
  34. > perl makepack-dolibarrmodule.pl
  35. --------------------------------------------------------------------------------------------------
  36. - To build developper documentation, launch the script
  37. > perl dolibarr-doxygen-build.pl
  38. --------------------------------------------------------------------------------------------------
  39. You can find in "build", following sub-directories:
  40. * composer
  41. To test an upgrade of a lib.
  42. * debian
  43. To build Debian package.
  44. * dmg:
  45. To build Mac OS package (not ready yet).
  46. * doap:
  47. To build Doap descriptor to promote/describe Dolibarr releases.
  48. * docker:
  49. To deploy Dolibarr with docker.
  50. * doxygen:
  51. Dir with config file to build doxygen documentation.
  52. * exe:
  53. To build exe package for Windows that distribute Dolibarr sources or
  54. to build the complete DoliWamp package.
  55. * gource:
  56. To build the video of history of git changes.
  57. * launchpad:
  58. Doc file to explain how to use launchpad.
  59. * obs:
  60. Doc file to explain how to push release onto OBS.
  61. * pad:
  62. To build a PAD file descriptor to promote/describe Dolibarr releases.
  63. * patch:
  64. Script file to generate a patch file to distribute a Dolibarr mod.
  65. * perl:
  66. Tool to install dolibarr when using virtualmin pro
  67. * rpm:
  68. To build Redhat, Opensuse or Mandriva package.
  69. * tgz:
  70. To build a tgz package.
  71. * travis-ci:
  72. Used by travis to make CI.
  73. * zip:
  74. To build a zip package.