The mORMot 2 documentation is available online at Synopse.info.
This folder hosts the source of the documentation of the mORMot Open Source framework, version 2.
You should not need to read or compile it, but rather browse the generated documentation available online at Synopse.info.
This Documentation and its source are licensed under a GNU General Public License, version 3.0 or later.
The framework source code contains detailed information about most of its published data structures, as comments prefixed by ///.
Our SynProject tool was used to extract these description, together with the types and variables definitions themselves, and generate accurate documentation.
Several chapters of information have also been written as plain text, and included in this folder. It presents high-level definition of the concepts involved in mORMot, or low-level presentation of the framework actual implementation.
The documentation source is mainly available in the mormot2.pro text file.
Our SynProject tool is the most convenient way of editing this mormot2.pro file content, on Windows.