Building Glimpse

From GlimpseWiki
Revision as of 04:01, 22 September 2019 by TrechNex (talk | contribs) (Initial content showing components, version control things and a notice about build tools)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Basic Principles

There are several components of the Glimpse source code that must be built in a specific order.

Component Purpose Link
BABL Converts between different image formats and color spaces http://www.gegl.org/babl/
MyPaint Provides different different brushes and image editing components http://mypaint.org/
GEGL Core engine for non-destructive image editing and processing http://www.gegl.org/
Glimpse Front end UI wrapper and plug-in framework based on the GNU Image Manipulation Program https://glimpse-editor.org

Version Control

The source code we maintain is available at https://github.com/glimpse-editor/Glimpse. We maintain the following locked branches:

Branch name Purpose
main Current stable release code (after Glimpse 0.1 is released)
dev-g210 Latest development changes added to the GNU Image Manipulation Program 2.10.12

You should ignore any other branches you see as they will usually be related to a pull request, and as a result they may not build and will usually be deleted once the changes have been merged into the development branch.

We have added the components that Glimpse project does not maintain as git submodules already preset at the correct tagged versions. This is provided for convenience so that you do not need to clone them separately and can have confidence that changes in the upstream "master" branches are not affecting your builds.

Build Tools

Because Glimpse 0.x is forked from the GNU Image Manipulation Program 2.10.12, we use Autotools and other programs contained within the GNU Build System. This also applies to the tagged versions of BABL, MyPaint and GEGL that we rely on.

When the GNU Image Manipulation Program 3.0 is released in 2020 the code will require Meson, an entirely different build system. If you do not stick to tagged releases of the components the Glimpse source code relies on, our documented build instructions will not work.

The Glimpse project and community can offer assistance with the instructions provided on https://wiki.glimpse-editor.org. If you choose to follow the upstream documentation instead and run into problems, we may not be able to help you.