The synit manual
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Tony Garnock-Jones 97f8c560e6
Comment out synit essay for now
4 months ago
src Comment out synit essay for now 4 months ago
.envrc Specify python3 11 months ago
.gitignore Add __pycache__/ to .gitignore 11 months ago
Makefile deploy target 11 months ago
README.md Update README 4 months ago
book.prb Ditaa-based diagrams 12 months ago
book.prs Ditaa-based diagrams 12 months ago
book.toml Pseudocode mdbook plugin 11 months ago
mdbook-ditaa Repair mdbook-ditaa plugin for `mdbook build` usage 11 months ago
mdbook-pseudocode Tweak spacing 11 months ago
mdbook_plugin.py Pseudocode mdbook plugin 11 months ago
style.css Pseudocode styling, to make it less painful on mobile browsers 11 months ago

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.

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:

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.

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

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