vacp2p
/
rfc
mirror of https://github.com/vacp2p/rfc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Modular p2p messaging stack, with a focus on secure messaging. https://rfc.vac.dev/
319 Commits 45 Branches 11 Tags 32 MiB
HTML 77.9%
Dockerfile 22.1%
Go to file
Sanaz Taheri Boshrooyeh 2234ddf53e
Update index.md (#370) 		2021-05-14 13:14:04 +08:00
.github/ISSUE_TEMPLATE Cleanup old stuff (#320) 2021-04-06 12:18:50 +08:00
archetypes Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
content Update index.md (#370) 2021-05-14 13:14:04 +08:00
example-content Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
layouts/docs Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
resources/_gen/assets/scss Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
static 10: Add overview (#340) 2021-04-09 13:16:23 +08:00
themes Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
.gitignore Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
.gitmodules Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00
.pyspelling.yml Update main.yml (#136) 2020-05-28 11:46:43 +02:00
.remarkrc adds link checks (#131) 2020-05-21 12:20:44 +08:00
.textlintrc text-lint (#134) 2020-05-25 11:55:06 +02:00
README.md Update README.md 2021-04-01 12:06:42 +08:00
config.toml http -> https (#328) 2021-04-06 16:50:48 +08:00
netifly.toml Merge repo with rfc.vac.dev (#310) 2021-04-01 12:03:14 +08:00

README.md

rfc.vac.dev

This repository contains the specs for vac, a modular peer-to-peer messaging stack, with a focus on secure messaging. A detailed explanation of the vac and its design goals can be found here.

See rfc.vac.dev.

Contributing

Please see 1/COSS for general guidelines and spec lifecycle.

Building locally

Ensure you have the Hugo extended edition (https://gohugo.io/getting-started/installing/), then run hugo server.

These protocols define various components of the vac stack.

Style guide

Sequence diagrams are generated using Mscgen like this: mscgen -T png -i input.msc -o output.png. Both the source and generated image should be in source control. For ease of readability, the generated image is embedded inside the main spec document.

Alternatively, mscgenjs can be used to generate sequence diagrams (mscgenjs produces better quality figures especially concerning lines' spaces and figures' margins). Once installed, the following command can be used to generate the sequence diagrams mscgenjs -T png -i input.msc -o output.png. More details on the installation and compilation are given in mscgenjs repository. You may try the online playground https://mscgen.js.org/ as well to get a sense of the output figures.

Meta

The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Acknowledgement

Site layout and process inspired by https://rfc.zeromq.org/