From 8511f3ce7a9ab24732a7687ac6964f20efe94f55 Mon Sep 17 00:00:00 2001 From: dev Date: Tue, 1 Oct 2024 17:51:00 -0400 Subject: [PATCH] Updates --- src/v2i-hub/docs/Programming_Guide.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/v2i-hub/docs/Programming_Guide.md b/src/v2i-hub/docs/Programming_Guide.md index fe293e55f..e001f052d 100644 --- a/src/v2i-hub/docs/Programming_Guide.md +++ b/src/v2i-hub/docs/Programming_Guide.md @@ -26,10 +26,15 @@ The Example Plugin showcases the basic functionality needed by a V2X Hub plugin. The Example Plugin structure is as follows: -- SampleBSMPlugin +- ExamplePlugin - src - - SampleBSMPlugin.cpp - - SampleBSMPlugin.h + - ExamplePlugin.cpp + - SampleData.h + - SampleData.cpp + - test + - Main.cpp + - ExampleTest.cpp + - SharedCodeTest.cpp - CMakeLists.txt - manifest.json - README.md @@ -40,7 +45,7 @@ The CMakeLists.txt file contains the needed information for cmake to create the The manifest.json file is used by the V2X Hub Core to setup communications between the core and plugin. The file contains a description of the plugin, the executable location, the IP address of the V2X Hub running the core application, port information for communication, messages that are produced by this plugin, and then finally the configuration values for the plugin. The majority of this file will remain untouched, except for the configuration, messageTypes, and description sections. More detail will be given on the modification of those sections in chapter 2. -The README.md is documentation for using the Plugin. Software without usage documentation is very difficult to reuse or extend. It is highly recommended that every new plugin includes usage documentation and follows the documentation template outlined [here](../../../examples/tmx-exampleapps/SampleBSMPlugin/README.md). +The README.md is documentation for using the Plugin. Software without usage documentation is very difficult to reuse or extend. It is highly recommended that every new plugin includes usage documentation and follows the documentation template outlined [here](../../../examples/tmx-exampleapps/ExamplePlugin/README.md). ### Sample API Calls