search

UniFormal / MMT

The MMT Language and System
https://uniformal.github.io/
Other
68 stars 22 forks source link

document the build process from the dev perspective. #190

Open kohlhase opened 7 years ago

kohlhase commented 7 years ago

There are many (>= 7) build targets, they are not self-explanatory (and in fact I suspect that after Christian left, nobody really knows what they do). More generally, there should be documentation on the whole build process, so that we can develop this further.

I am calling for dev-level documentation that actually coincides with what the code does. There is a blue note at https://gl.kwarc.info/oaf/build-system/blob/master/note.pdf but that has been written independently and tries to write down the relevant concepts; it certainly needs to be synchronized with the code, if it is to be the nucleus of this documentation.

I hope that I can write this note further together with @Jazzpirate, maybe @florian-rabe can help/discuss.

I hope to document the user/admin perspective of the build process at https://github.com/KWARC/MathHub/issues/244

kohlhase commented 7 years ago

I just saw (had forgotten), there is a start of such a documentation at https://mathhub.info/help/build-system.html; I will continue documenting there.