windows/calligra_installer/README.txt

0001 c2winstaller README
0002 -------------------
0003
0004 This includes instructions for preparing your environment to build an MSI installer for Calligra on Windows.
0005
0006 Preparation
0007 -----------
0008
0009 You will need to have a working KDE Windows environment which lets you build Calligra on the Windows platform.
0010 This also meets the requirement for having a working python interpreter in order to run supporting scripts.
0011
0012 The recommended folder structure is:
0013 parent
0014 +-c2winstaller
0015 +-c2winstaller-input   (receives a packaged version of Calligra + KDE, output from package.bat)
0016 +-c2winstaller-output  (intermediate and complete MSI written by build_msi.bat process)
0017 +-c2winstaller-temp    (temp folder used by the package.bat process)
0018 +-deps        (stores 3rd party dependencies - Visual C++ runtime components for the installer)
0019   +-vcredist
0020     +-DLLs
0021         +-MergeModules    (stores .msm files distrubuted with Visual Studio)
0022 +-wix36       (install wix 3.6 here)
0023
0024 You will require the latest copy of the Wix toolset, 3.6 beta.
0025 This may be downloaded from http://wixtoolset.org/
0026
0027 Checking the Environment
0028 ------------------------
0029 You will need to ensure some paths are set prior to calling package.bat or build_msi.bat
0030
0031 To choose how/whether to distribute the VC++ runtime files, you must set C2WINSTALL_VC2010_DISTRIBUTE to point to the process you intend to use.
0032     DLL - informs wix that you want to distribute DLLs with it
0033         MSM - informs wix that you want to use the MergeModule
0034         (any other value is ignored and causes an error message to be displayed if it is not found, but a value must be set)
0035
0036 If wix has been installed anywhere other than ..\wix36, then you must set C2WINSTALL_WIX_BIN to point to it
0037
0038 You must set CALLIGRA_INST to point to the inst folder of the Calligra installation.
0039 KDEROOT is set by kdeenv, so should not need to be explicitly declared.
0040
0041 C2WINSTALL_GITREV - the intention is for this to take a git revision identifier. This needs to be set in advance, and would normally be set by the build process which created the Calligra installation.
0042 C2WINSTALL_VERSION - the version number of the package. This must consist of four sets of digits separate by periods (e.g. 2.3.87.1)
0043
0044 These variables are automatically populated by build_msi.bat, with the help of the
0045
0046
0047 Packaging Calligra
0048 ------------------
0049 You will need to run the following within a working KDE for Windows environment.
0050 From the c2winstaller directory, call:
0051 env
0052
0053 This sets most of the required environment variables, using defaults unless you have overriden these previously.
0054 You will need to set CALLIGRA_INST if you intend to package
0055
0056 Now you can run:
0057 package
0058
0059 This will copy files from CALLIGRA_INST and KDEROOT in to C2WINSTALL_INPUT, packaging the Windows distribution of Calligra with the required KDE files.
0060 The C2WINSTALL_TEMP folder contains some files that package touches, but it should clean this up on completion.
0061 This should complete without errors (although you may need to prompt it to overwrite files ...may need to review this behaviour)
0062
0063 Once this has completed, you are ready to run:
0064 build_msi
0065
0066 This will fun all the required steps:
0067   heat to read the C2WINSTALL_INPUT directory in order to generate HeatFragment.wxs
0068   candle to build the intermediate obj files fromm the xml sources
0069   light to build the msi file.
0070
0071