mmondora / specification

Safe Together specification repository

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

SafeTogether Specification

SafeTogether is an ecosystem of software components and support services to provide the operators in charge with a set of tools to help tackle phase 2 of the epidemic emergency.

This repository contains the source of the SafeTogether Specification which aims to be a clear, unambiguous, free and implementable documentation for SafeTogether Project.

For the time being, while the migration is in progress, please refer also to the existing draft documents available in reference implementation repositories.

A fair number of spec improvements are currently in the making. If you want to contribute, please refer to a relevant panel.

Editing and building the specification

The specification is built using Bikeshed.

Pushing to master triggers the compliation and publishing in GitHub pages.

Local building & test

If needed, download and install docker community engine

This command will generated html files in project root, main, stories and process direcories:

docker run --rm -t -v ${PWD}:/data  -w /data linkeddatacenter/bikeshed ./build 

Note that by default, the generated .html files will not pushed to repository.

About

Safe Together specification repository

License:MIT License


Languages

Language:Shell 100.0%