From 3a25704f4142cf2eed2ff5a4ab0aa4b6639b50de Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Tue, 30 Aug 2016 13:55:37 -0700 Subject: [PATCH] [README] Add link to KSP plugin Add link to David Hudson's Kerbal Space Program plugin from #1146, along with other information about Examples relevant in that context. Resolves #1064 --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index cce52a9921..c19be6ee1d 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,22 @@ Open MCT is now running, and can be accessed by pointing a web browser at [http: Documentation is available on the [Open MCT website](https://nasa.github.io/openmct/documentation/). The documentation can also be built locally. +### Examples + +The clearest examples for developing Open MCT plugins are in the +[tutorials](https://nasa.github.io/openmct/docs/tutorials/) provided in +our documentation. + +For a practical example of a telemetry adapter, see David Hudson's +[Kerbal Space Program plugin](https://github.com/hudsonfoo/kerbal-openmct), +which allows [Kerbal Space Program](https://kerbalspaceprogram.com) players +to build and use displays for their own missions in Open MCT. + +Additional examples are available in the `examples` hierarchy of this +repository; however, be aware that these examples are +[not fully-documented](https://github.com/nasa/openmct/issues/846), so +the tutorials will likely serve as a better starting point. + ### Building the Open MCT Documentation Locally Open MCT's documentation is generated by an [npm](https://www.npmjs.com/)-based build. It has additional dependencies that