README 2.67 KB
Newer Older
1 2 3
Developers documentation 
------------------------

Sven Neumann's avatar
Sven Neumann committed
4 5
This directory holds information that you will find useful if you
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

Michael Natterer's avatar
Michael Natterer committed
13 14 15
   libgimp
   libgimpbase
   libgimpcolor
16
   libgimpconfig
Michael Natterer's avatar
Michael Natterer committed
17
   libgimpmath
Sven Neumann's avatar
Sven Neumann committed
18
   libgimpmodule
19 20 21 22 23 24 25 26 27
   libgimpthumb
   libgimpwidgets          - complete libgimp documentation generated from
                             the source; see README.gtkdoc

   tools                   - the source code for tools used to generate
                             documentation



28 29
   gitlab-milestones.txt   - describes how the GIMP project uses
                             milestones in the GNOME gitlab issue tracker
30 31
   commit-rules.txt        - describes rules and things to think
                             about when creating GIMP commits
32
   contexts.txt            - describes how GimpContexts are used in GIMP
33 34 35 36 37 38 39
   debug-plug-ins.txt      - how to debug GIMP plug-ins
   exif-handling.txt       - how GIMP should handle EXIF data
   includes.txt            - the policy for inclusion of header files
   parasites.txt           - descriptions of known parasites
   release-howto.txt       - a check-list for doing a GIMP release
   submitting-patches.txt  - how to submit a patch for GIMP
   tagging.txt             - how resource tagging in Gimp works
40
   ui-framework.txt        - describes how the GIMP UI framework functions and
41 42 43 44 45 46 47 48 49
                             how it is implemented
   undo.txt                - description of the undo system


   structure.xml           - a DocBook article that gives an overview on
                             the directory structure of the GIMP source tree,
                             also check out gimp-module-dependencies.svg


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 54 55 56 57 58 59 60 61
                             GIMP gradients
   gih.txt                 - description of the GIH format used to store a
                             series of pixmap brushes
   gpb.txt                 - OBSOLETE: description of the GPB format for
                             pixmap brushes
   pat.txt                 - description of the PAT format for patterns
   vbr.txt                 - description of VBR format used for
                             "generated" brushes
   xcf.txt                 - description of Gimp's XCF format