Skip to content

Latest commit

 

History

History
21 lines (11 loc) · 1.7 KB

README.md

File metadata and controls

21 lines (11 loc) · 1.7 KB

Polkadot Host Specification

Here your can find the source code of the Polkadot Host Specification.

Please refer to the Change log to review the history of changes to the host specification in the past.

Official releases of the specification can be found on the release page of this repository.

Editing

The specification is edited with TeXmacs with an additional style package algorithmacs-style.ts (from https://github.com/w3f/algorithmacs) that must be copied or linked to your personal style package directory $HOME/.TeXmacs/packages.

All figures can be found in the figures subdirectory. The .eps files should be edited with "Adobe Illustrator", the .puml files with plantuml and the .pdf files with diagrams.net.

Command line build and diff support

There is a Makefile to simplify the generation of PDFs and diff PDFs. This feature requires xvfb to be installed. To build the polkadot-host-spec.pdf just use make or make build. To generate polkadot-host-spec.diff.pdf use make diff REV=<revision> where <revision> can be any previous revision to which to compare, i.e. a branch, tag or commit. The resulting polkadot-host-spec.diff.pdf highlights the differences between the <revision> version of the specification with the current version using different colors (red indicates <revision> version and green refers to the current version of the text).

To update table of content, bibliography, indices and glossar (e.g. before committing) there is make update which runs TeXmacs to update each of them and save the result.