synit-manual/README.md

Synit Manual

Welcome!

Synit is an experiment in applying pervasive reactivity and object capabilities to the System Layer of an operating system for personal computers, including laptops, desktops, and mobile phones.

This is the manual for the system.

• Project homepage: https://synit.org/
• Source code: https://git.syndicate-lang.org/synit/

Repository contents

The manual text:

• src/ contains the markdown files making up the main source text of the manual.

Support software:

• book.prs and the corresponding binary, book.prb, describe the protocol used for communication between mdbook and its plugins.
• book.toml is the configuration file for mdbook.
• mdbook_plugin.py is a support library for writing mdbook plugins.
  • mdbook-ditaa is a plugin for mdbook that renders (and caches) ditaa diagrams from the source text into SVG for the built website.
  • mdbook-pseudocode is a plugin for mdbook that makes a pretty rendering of pseudocode snippets in the source text.

After running a build, the ./book subdirectory contains the rendered result.

Building the manual

You will need several tools:

• mdbook

• a JVM and ditaa version 0.11.0

• Python 3.x and the Preserves python package (pip install -U preserves)

Running make or make all should do the trick. See also the Makefile and .envrc.

Acknowledgements

Much initial work on Synit was made possible by a generous grant from the NLnet Foundation as part of the NGI Zero PET programme. Please see "Structuring the System Layer with Dataspaces (2021)" for details of the funded project.

Copyright and License

This manual is licensed under a Creative Commons Attribution 4.0 International License.
Copyright © 2021–2022 Tony Garnock-Jones tonyg@leastfixedpoint.com.

The Synit programs and source code are separately licensed. Please see the source code for details.