I think this is a good idea.

Ideally, for me at least, this would be documented in the source code as comments before the structs in question. A second approach is, as you suggest, some sort of external document such as another text file like a "Getting Started for Developers" guide, say DEVELOP.txt. This would be a good place to introduce the core/GUI relationship, basics of debugging Pd (build with -g and use gdb/lldb), code structure overview, and perhaps some other useful tricks like using the find console command to search the source files. I basically have a script which uses find to help be print out the location of functions, variable names, etc which is *always* helpful as I never remember where anything is in the pd sources. :P

On Oct 22, 2019, at 5:15 PM, pd-list-request@lists.iem.at wrote:

That little description on CHANGELOG.txt was not meant to be a introduction to those structures - that was kind of an accident.
Maybe we could have a file giving a brief introduction on how PD works. Maybe we could open a git repo like the externals-howto<https://github.com/pure-data/externals-howto>.
I imagine that over time it would increase collaborations on the PD source

--------

Dan Wilcox

robotcowboy.com