development/Win32/packaging/README

   1 Packaging LyX for Windows
   2 ===============================
   3 Angus Leeming, 07 March 2006
   4 ===============================
   5
   6 Preparing the way
   7 =================
   8
   9 The very first thing to do on the way to creating a LyX/Win package is
  10 to build the sources and install them somewhere accessible. I've written
  11 a script, build_lyxwin.sh, that performs all the necessary steps. Please
  12 read the preamble and (un)comment those steps that are necessary at the
  13 end of the script.
  14
  15 The (eventual --- mingw is a *very* slow compiler) result is a lyx
  16 package that's almost ready to go in $LYX_SRCS/build/installprefix.
  17
  18 Thereafter, the contents of this tree must be manipulated a
  19 little. I've written a little script, package_lyxwin.sh, to automate
  20 the process:
  21
  22 * Copy the DLLs qt-mt3.dll, libiconv-2.dll, mingwm10.dll to the
  23   $PREFIX/bin/ directory. These are needed by the LyX executable.
  24
  25 * Strip the binaries in $PREFIX/bin/ of all debugging info.
  26
  27 * Copy dt2dv.exe and dv2dt.exe to $PREFIX/bin/ and clean_dvi.py to
  28   $PREFIX/Resources/scripts/ These are needed to enable dvips, yap
  29   et al. to cope with "file names with spaces".
  30
  31 * Add formats and converters to the $PREFIX/Resources/configure
  32   script so that users can use the clean_dvi script transparently.
  33
  34 * Remove all stuff generated by running configure. It makes sense on
  35   your machine only, not for whoever is installing LyX. Specifically
  36
  37   xfonts/fonts.dir, xfonts/fonts.scale, doc/LaTeXConfig.lyx,
  38   lyxrc.defaults, packages.lst and textclass.lst
  39
  40   should all be removed.
  41
  42 Creating the LyX icons
  43 ======================
  44
  45 All icons are to be found in sub-directory icons/.
  46
  47 The LyX icons, lyx_32x32.ico and lyx_doc_32x32.ico, are based on .svg
  48 files written and realease into the public domain by Andy Fitzsimon:
  49
  50 http://openclipart.org/clipart/computer/icons/etiquette-theme/aps/LyX.svg
  51 http://openclipart.org/clipart/computer/icons/etiquette-theme/mimetype.svg
  52
  53 lyx.svg is Andy's original.
  54 lyx_doc.svg is a merger of LyX.svg with mimetype.svg
  55
  56 Working on a linux box, I used sodipodi (http://www.sodipodi.com/) to
  57 create the .svg file and to export these vector graphics images to
  58 32x32 pixel bitmaps (.png format). Thereafter I used gimp
  59 (http://www.gimp.org/) to generate reduced color depth versions (16,
  60 256 colors).
  61
  62 Finally, on a WindowsXP machine, I used IconXP
  63 (http://www.aha-soft.com/iconxp/) to build the .ico files from these
  64 .png files at differing resolutions.
  65
  66 Adding the LyX icons to lyx.exe
  67 ===============================
  68
  69 ********************************************************************
  70 NOTE: Run 'strip' on lyx.exe before adding any images to it. 'strip'
  71 will not work after images have been added.
  72
  73 $ strip lyx.exe
  74 j:\mingw\bin\strip.exe: lyx.exe: File in wrong format
  75 ********************************************************************
  76
  77 Windows executables can store various "resources", including images. I
  78 used ResourceHacker (http://rpi.net.au/~ajohnson/resourcehacker) to
  79 add the LyX icons to the .exe file.
  80
  81 Fire up ResHacker.exe and load lyx.exe
  82 File>Open... lyx.exe
  83
  84 Action>Add a new Resource...
  85 Open file with resource ... lyx_32x32.ico
  86    Resource Type will be set to "ICONGROUP"
  87 Set Resource Name to "1". (No inverted commas.)
  88 Add Resource
  89
  90 The icon will be shown in the main Resource Hacker window under
  91 Icon Group>1>0 and as Icon>5[0-3].
  92
  93 Repeat for lyx_doc_32x32.ico, setting the Resource Name to "2".
  94
  95 Save the modified lyx.exe. Resource Hacker will copy the original to
  96 lyx_original.exe. Remove it.
  97
  98 Building the LyX installer
  99 ==========================
 100
 101 At this point my build/installprefix tree now contains everything that is
 102 to be released as a LyX/Win package. All that remains to do is to
 103 generate a Windows installer for it. I've written a script for NSIS
 104 (http://nsis.sourceforge.net/) to compile into an installer.
 105
 106 You'll need to compile and install lyx_path_prefix.dll. From the
 107 comments in lyx_path_prefix.C:
 108
 109 /* Compile the code with
 110  *
 111  * g++ -I/c/Program\ Files/NSIS/Contrib -Wall -shared \
 112  *    lyx_path_prefix.c -o lyx_path_prefix.dll
 113  *
 114  * Move resulting .dll to /c/Program\ Files/NSIS/Plugins
 115  */
 116
 117 Thereafter, you'll be able to build the installer itself:
 118
 119 $ <PATH to>/makensis lyx_installer.nsi
 120
 121 creating lyx_setup_136.exe ready to ship.
 122
 123 END README