Skip to content
Informo specifications
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
content
layouts
scripts
static
themes
.gitignore
.gitmodules
LICENSE
README.md
config.toml

README.md

Informo specifications

https://specs.informo.network FDL-1.3 open proposals merged proposals #discuss:weu.informo.network on Matrix

Welcome to Informo's specifications repository. Informo's specifications aim at giving a precise understanding of how Informo works.

A live version of the specifications generated from the source files in this repository can be found at https://specs.informo.network/. This live version is generated from the master branch, and is re-deployed each time new commits are pushed to the said branch.

Build the documentation

The specifications are built using hugo, which you will need to install before being able to build it.

When cloning this repository, make sure to initialise and update its submodules, as the built version depends on an external theme which is referenced as a submodule:

git clone https://github.com/Informo/specs --recurse-submodules

Then just run hugo at the root of the repository. It will generate a static version of it in a public directory.

Build the schemas

For the sake of simplicity, this documentation uses SVG schemas, located in /static/images, in several locations. To make them render the same way for every platform, text font is converted to svg paths.

A copy of the version with written text is available for each schema, with its name ending with .src.svg. After modifying one of those, text must be converted to paths again, by running ./scripts/svg-fonts-to-path.sh from the root of the repository. The script uses Inkscape, which must be installed on the system before generating the new versions of the schemas.

The schemas have been initially generated on a GNU/Linux system using the "Sans" system font. In order to get a similar result, it is advised to perform any generation on a similar system.

Contribute

Contributions to the Informo specifications are welcome. These must follow Informo's Specifications Changes Submission Protocol.

While working on a submission, using hugo's watcher might be easier than manually running hugo each time you make a change:

hugo server

This command must be run from the root of the repository. Hugo will start a webserver on http://127.0.0.1:1313 (unless instructed otherwise), and rebuild (and reload) the site on every change.

Get in touch

Whether it is to get to know Informo, to look for a way to contribute, or for any other reason, anyone is welcome to join the discussion and overall chatter in our Matrix room or our IRC channel.

You can also reach the Informo core team in a more private way by sending an email to core@informo.network.

You can’t perform that action at this time.