README.Packagers

   1 Notes for package maintainers
   2 -----------------------------
   3
   4
   5 About this file
   6 ---------------
   7 The following notes are intended for package maintainers. These are not
   8 meant as strict rules but only as hints and ideas to make a package
   9 maintainer's life a little bit easier.
  10 So it doesn't make much sense to include this file in any created
  11 packages for general distribution.
  12
  13
  14 Packaging hints
  15 ---------------
  16 If the final file size of the created packaged is a problem, you might
  17 ignore some files and don't package them or put them into a separate
  18 package. This can be easily done (without any further complications)
  19 with the translations files(files in %prefix/share/locale/).
  20 Another possibility is to skip the tags files in the data/ subdirectory.
  21 These are only for auto completion of global symbols. If the files are
  22 missing Geany just doesn't provide these global symbol auto completion
  23 but all other things will work anyways.
  24 You can also skip packaging the full HTML documentation including
  25 images. But if you do so, please include at least the text form of the
  26 manual.
  27 What you shouldn't skip in your package: the filetype.* files in the
  28 data/ subdirectory, these files are important. If they are missing,
  29 Geany still has a fallback mechanism for syntax highlighting (if
  30 filetypes.common is installed) but several other features for certain
  31 filetypes will fail (mainly build support).
  32
  33
  34 Testing your package
  35 --------------------
  36 There are a few things to take care of when you create a package:
  37 - Please check whether you include the following files:
  38   ScintillaLicense.txt, README, manual.txt, COPYING.
  39   ScintillaLicense.txt is the name of the installed file in the doc/
  40   directory. In the source distribution, this file can be found in
  41   scintilla/License.txt.
  42   The file COPYING is the GPLv2 license text and should(have to?) be
  43   included in your package.
  44 - Start Geany after it was installed out of your package. Pass the
  45   command line argument "-v" to see whether Geany complains about
  46   missing files.
  47 - Check whether the help menu item (Help->Help or F1) works and opens
  48   the local installed HTML documentation in your browser (if it opens
  49   the manual on the website you didn't install the HTML manual correctly
  50   and Geany falls back to the online manual).
  51 - Check the About dialog (Help->About) whether it displays the full
  52   GPLv2 license text on the last tab("License").
  53
  54
  55 Feedback
  56 --------
  57 If you have to modify anything to package the Geany sources for your
  58 distribution/target and these changes might be generally useful, please
  59 report your changes to us(the Geany developers) so we can apply them.
  60 Such changes could be removing/adding any files, modifying the autotools
  61 configuration, any modifications to some "meta" files (like
  62 geany.desktop, geany.spec, images/icons, ...) or even if you have to
  63 modify the source code to fix broken compilation or something like this.
  64 Please inform us about changes you made, so maybe you don't have to
  65 change it again with the next release and we can fix it in Geany itself
  66 so others could also benefit from these changes.
  67
  68
  69 Announce your packages
  70 ---------------------
  71 After finishing your package creation, feel free to drop a note on
  72 Geany's mailing list or directly to us (the Geany developers) to
  73 inform us about it. If you wish, we can also add a link on Geany's
  74 website to your package.
  75
  76
  77 Geany announcements
  78 -------------------
  79 Package maintainers are encouraged to subscribe to the Geany mailing
  80 list to stay informed about major changes and of course, new releases.
  81
  82
  83
  84 --
  85 2008-2010 by Enrico Tröger, Nick Treleaven and Frank Lanitz
  86 enrico(dot)troeger(at)uvena(dot)de
  87 nick(dot)treleaven(at)btinternet(dot)com
  88 frank(at)frank(dot)uvena(dot)de