vacp2p/rfc
1
0
Fork 0
mirror of https://github.com/vacp2p/rfc.git synced 2025-01-11 15:24:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add style guide on sequence diagrams

Browse Source
This commit is contained in:
Oskar Thoren 2019-09-24 13:29:48 +08:00
parent 33343dacc7
commit 431b9642d8
No known key found for this signature in database
GPG Key ID: B2ECCFD3BC2EF77E
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -11,6 +11,9 @@ The entire vac protocol is under active development, each specification has its
These protocols define various components of the [vac](https://vac.dev) stack.
- [mvds](./mvds.md) - Ensure reliable messaging between peers across an unreliable peer-to-peer (P2P) network where they may be unreachable or unresponsive.
## Style guide
<!-- @Todo put this in a better place !-->
All specs follow [RFC-2119](https://tools.ietf.org/html/rfc2119).
Sequence diagrams are generated using [Mscgen](http://www.mcternan.me.uk/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.