summaryrefslogtreecommitdiffstats
path: root/devel-docs/README
diff options
context:
space:
mode:
Diffstat (limited to 'devel-docs/README')
-rw-r--r--devel-docs/README61
1 files changed, 61 insertions, 0 deletions
diff --git a/devel-docs/README b/devel-docs/README
new file mode 100644
index 0000000..5fc7cdb
--- /dev/null
+++ b/devel-docs/README
@@ -0,0 +1,61 @@
+Developers documentation
+------------------------
+
+This directory holds information that you will find useful if you
+develop a GIMP plug-in or want to work on the GIMP core.
+
+See https://wiki.gimp.org/index.php/Main_Page for more information.
+
+ app - setup for documentation of the GIMP core;
+ not built by default since it is huge and
+ only relevant for core developers
+
+ libgimp
+ libgimpbase
+ libgimpcolor
+ libgimpconfig
+ libgimpmath
+ libgimpmodule
+ libgimpthumb
+ libgimpwidgets - complete libgimp documentation generated from
+ the source; see README.gtkdoc
+
+ tools - the source code for tools used to generate
+ documentation
+
+
+
+ gitlab-milestones.txt - describes how the GIMP project uses
+ milestones in the GNOME gitlab issue tracker
+ commit-rules.txt - describes rules and things to think
+ about when creating GIMP commits
+ contexts.txt - describes how GimpContexts are used in GIMP
+ 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
+ ui-framework.txt - describes how the GIMP UI framework functions and
+ 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
+
+
+ gbr.txt - description of the GBR format used to store
+ pixmap brushes
+ ggr.txt - description of the GGR format used to store
+ 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