devel-docs/README

   1 Developers documentation
   2 ------------------------
   3
   4 This directory holds information that you will find useful if you
   5 develop a GIMP plug-in or want to work on the GIMP core.
   6
   7 See https://wiki.gimp.org/index.php/Main_Page for more information.
   8
   9    app                     - setup for documentation of the GIMP core;
  10                              not built by default since it is huge and
  11                              only relevant for core developers
  12
  13    libgimp
  14    libgimpbase
  15    libgimpcolor
  16    libgimpconfig
  17    libgimpmath
  18    libgimpmodule
  19    libgimpthumb
  20    libgimpwidgets          - complete libgimp documentation generated from
  21                              the source; see README.gtkdoc
  22
  23    tools                   - the source code for tools used to generate
  24                              documentation
  25
  26
  27
  28    gitlab-milestones.txt   - describes how the GIMP project uses
  29                              milestones in the GNOME gitlab issue tracker
  30    commit-rules.txt        - describes rules and things to think
  31                              about when creating GIMP commits
  32    contexts.txt            - describes how GimpContexts are used in GIMP
  33    debug-plug-ins.txt      - how to debug GIMP plug-ins
  34    exif-handling.txt       - how GIMP should handle EXIF data
  35    includes.txt            - the policy for inclusion of header files
  36    parasites.txt           - descriptions of known parasites
  37    release-howto.txt       - a check-list for doing a GIMP release
  38    submitting-patches.txt  - how to submit a patch for GIMP
  39    tagging.txt             - how resource tagging in Gimp works
  40    ui-framework.txt        - describes how the GIMP UI framework functions and
  41                              how it is implemented
  42    undo.txt                - description of the undo system
  43
  44
  45    structure.xml           - a DocBook article that gives an overview on
  46                              the directory structure of the GIMP source tree,
  47                              also check out gimp-module-dependencies.svg
  48
  49
  50    gbr.txt                 - description of the GBR format used to store
  51                              pixmap brushes
  52    ggr.txt                 - description of the GGR format used to store
  53                              GIMP gradients
  54    gih.txt                 - description of the GIH format used to store a
  55                              series of pixmap brushes
  56    gpb.txt                 - OBSOLETE: description of the GPB format for
  57                              pixmap brushes
  58    pat.txt                 - description of the PAT format for patterns
  59    vbr.txt                 - description of VBR format used for
  60                              "generated" brushes
  61    xcf.txt                 - description of Gimp's XCF format