Ansel 0.0
A darktable fork - bloat + design vision
Loading...
Searching...
No Matches
Ansel Dev doc

Welcome on the new Ansel developer documentation. As it is brand-new, it is still in progress, but we are getting there.

Getting started

Getting the source code

You will need Git:

git clone --recurse-submodules https://github.com/aurelienpierreeng/ansel.git

For cross-plateform building instructions, please refer to the user doc.

Getting in sync with the project

Who are our users ? What are we trying to to ? How do we tackle problems ? How do we manage the project and its priorities ? Read the contributor section.

Find issues to tackle

Scope and purpose of the present doc

At this stage, the present documentation is mostly the API reference automatically built by Doxygen from the (few) docstrings found in the source code, in particular in .h header files. Those documented objects aim at being reusable, so a documentation makes them public.

Dependencies and function calls graphs are also plotted for each object. These are useful to track bugs through the chain of callings without having to grep them in the code, in a less graphical way. They also show the shitshow inherited from upstream Darktable in terms of non-modular modules : you see how everything includes everything, so the spaghetti code becomes quite literally visible.

As time will go, we will add real dev documentation, explaining how the core tasks are handled, based on what assumptions and covering what use cases. This should prevent re-implementing the same feature, sometimes 4 times or more, as was seen in Darktable since 2020.

Useful links