diff options
Diffstat (limited to 'doc/src/README')
| -rw-r--r-- | doc/src/README | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/src/README b/doc/src/README new file mode 100644 index 0000000..cd2f22b --- /dev/null +++ b/doc/src/README @@ -0,0 +1,28 @@ +LibMCPU documentation sources +============================= + +These are the editable XeLaTeX sources for: + + libmcpu-bytecode-architecture-ru.pdf + libmcpu-melf-abi-ru.pdf + +Build both manuals with: + + ./build-docs.sh + +The manuals intentionally do not embed the LibMCPU package release number. +They document the current architectural contracts; package release history +belongs to NEWS.md and ChangeLog, while installed utilities report the actual +package version through --version / --dump-version. + +The manuals use the memoir-based LibMCPU book style with Roboto body text, +vector TikZ diagrams, booktabs/tabularx tables and breakable command/code +blocks. The build script performs three XeLaTeX passes for each document and +writes both PDFs to doc/. + +The bytecode manual contains the signed HLL Runtime ABI contract joining +mcpu-ld, CRT and MCPU Libc, together with reference appendices for assembler +directives, all architectural opcodes, PSW branch selectors and RCONST +selectors. The MELF manual documents static ABI v1, historical ABI v2 and +the frozen normal dynamic ABI v3, including HLL CRT integration layered above +the MELF container contract. |