synit
/
synit-manual
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity
The synit manual
98 Commits 1 Branch 0 Tags 582 KiB
Rust 48.9%
TypeScript 30.5%
Python 18.6%
Makefile 1.3%
CSS 0.7%
Go to file
Tony Garnock-Jones b24b4a0ee7 Correct typo 2023-11-24 13:39:29 +01:00
src Correct typo 2023-11-24 13:39:29 +01:00
.envrc Specify python3 2022-03-09 11:34:13 +01:00
.gitignore Add __pycache__/ to .gitignore 2022-03-09 09:49:58 +01:00
Makefile deploy target 2022-03-09 11:25:42 +01:00
README.md Update README 2022-10-12 14:22:24 +02:00
book.prb Recompile book.prb 2023-10-16 17:17:20 +02:00
book.prs Ditaa-based diagrams 2022-02-11 13:43:39 +01:00
book.toml Pseudocode mdbook plugin 2022-03-03 19:31:37 +01:00
mdbook-ditaa Repair mdbook-ditaa plugin for `mdbook build` usage 2022-03-09 09:58:02 +01:00
mdbook-pseudocode Tweak spacing 2022-03-04 10:47:47 +01:00
mdbook_plugin.py Pseudocode mdbook plugin 2022-03-03 19:31:37 +01:00
style.css Pseudocode styling, to make it less painful on mobile browsers 2022-03-03 17:26:43 +01:00

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.

Copyright and License

Creative Commons 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.