From d1acc8bc68368899eeb806be856241c5056f666c Mon Sep 17 00:00:00 2001 From: Jon Nordby Date: Tue, 20 Sep 2016 18:19:41 +0200 Subject: [PATCH] README: Document how to add runtime info --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f3d00409a..aa4ddb865 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,22 @@ Please read more from . See also the [availabl ## FBP systems support Even though the UI itself is built with NoFlo, it isn't talking directly with NoFlo for running and building graphs. -Instead, it is utilizing the [FBP Network Protocol](http://noflojs.org/documentation/protocol/) which enables it to talk to any compatible FBP system. +Instead, it is utilizing the [FBP Network Protocol](http://noflojs.org/documentation/protocol/) which enables it to talk to *any* compatible FBP system. +Currently over 5 different runtimes are known to work. + +By implementing the protocol in your runtime, you can program it with NoFlo UI. +If you use WebSockets or WebRTC as the transport, you do not need to change anything on NoFlo UI. +You can also [add support other transports](https://github.com/noflo/noflo-runtime). + +### Adding new runtime information + +One can *optionally* add component templates, syntax highlighting and a 'get started' link for new runtimes. + +1. Add a new YAML file with runtime info as `./runtimeinfo/myruntime.yaml`. [Example](./runtimeinfo/msgflo.yaml) +2. Include it in [./runtimeinfo/index.coffee](./runtimeinfo/index.coffee) +3. Commit the changes +4. Send a [Pull Request](https://github.com/noflo/noflo-ui/pull/new/master), so everyone benefits! -By implementing the protocol in your runtime, you can program it with NoFlo UI. If you use WebSockets or WebRTC as the transport, you do not need to change anything on NoFlo UI. One can optionally add syntax highlighting and a 'get started' link to the list of supported runtimes. -If you need/want to use another transport, you can add [support for that](https://github.com/noflo/noflo-runtime). ## Development of NoFlo UI