doc/HACKING

   1 Hacking
   2 =======
   3
   4 If you intend to modify the source code, you may additionally need
   5 these programs:
   6
   7     * GNU Autotools (autoconf >= 2.5, automake)
   8     * ImageMagick
   9
  10 You can pass the '--enable-tools' flag to the configure script to build
  11 a few additional programs that may be useful if you intend to seriously
  12 play with Enigma's internals.
  13
  14
  15 FAQ - Notes
  16
  17 - unreadable characters in sources --- utf8 coded sources like menu.cc, *.po
  18
  19 GCC incl 4.0 does not support standard C++ unicode escapes like "\u00E7" as a
  20 french cedille. But GCC accepts code written coded as utf8.
  21 Please configure your editor to read and write utf8.
  22
  23 - enigma.pot as a generated file in repository
  24 enigma.pot is made if missing and on explicit command (make dist ) but not
  25 on standard make due to performance issues. If not in repository enigma.pot
  26 would be regenerated once after checkout with an update of all *.po.
  27 Further changes would be ignored and all resulting *.po would be recommited
  28 into the repository!
  29
  30 - eliminate trailing '/' from gcc -I paths
  31
  32 This is for mingw gcc 3.4.2 compatibility. No problem with 3.4.1 and should be
  33 no more problem with 3.4.4. As soon as the current mingw release updates to a
  34 corrected gcc version we can skip this workaround.
  35
  36 - lua code in repository is native but in exe distribution LF terminated
  37 Lua produces errors with CR+LF. By declaring lua files as native the repository
  38 will be free of CR+LF independent from the level authors editor. If we would not
  39 declare it native we would depend on the authors awareness of this problem.
  40
  41 - the executable is large - why static link with xerces-c 3.0 for windows
  42 The trunk xerces 3.0 version libs are not stripped - strip enigma and it looks
  43 better. The Windows version currently generates no dll - you can do it by hand.
  44 But eitherway the static linked version will be smaller after upx than the
  45 shared one plus the dll. The Windows zip distribution grows from 11 MB only by
  46 appr. 650 KB to 11.5 MB.
  47