Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 1.91 KB

README.md

File metadata and controls

58 lines (34 loc) · 1.91 KB
Raw

Specification Template

This is the working area for the Trust over IP specification template.

Using this template

Two ways to use the template:

  • The green Use this template button in the upper right. Then select Create new repository or
  • When creating a new repository from the Repository template menu select toip/specification-template

After setting up your new repository you will need to configure GitHub pages.

Under Settings -> Code and automation -> Pages ensure the following settings are applied

  • Build and deployment -> Source -> Deploy from a branch
  • Build and deployment -> Branch -> gh-pages
  • Build and deployment -> Branch -> folder -> / (root)

Editing locally

In the root of the repository run npm install to install dependencies.

Run npm run render to render the HTML under docs/index.html this can then be previewed in your browser.

Run npm run edit to watch for changes and re-render the HTML.

Be sure to remove references to specification-template in favor of your new specification!

Experimental PDF generation

To output a PDF (on macOS, requires Python)

# brew install pandoc # brew install librsvg homebrew/cask/basictex

# python combine.py # chmod +x pdf.sh # ./pdf.sh

Contributing

All Trust Over IP Foundation Technical Stack Working Group contributions are done so under the following licenses:

Licensing

All Trust Over IP Foundation Technical Stack Working Group deliverables are published under the following licenses:

Getting involved

Join a community of individuals and organizations solving the toughest technical and human-centric problems in digital trust. https://trustoverip.org/get-involved/membership/