diff --git a/src/viam/examples/modules/simple/README.md b/src/viam/examples/modules/simple/README.md index 8d7db2839..c26390b79 100644 --- a/src/viam/examples/modules/simple/README.md +++ b/src/viam/examples/modules/simple/README.md @@ -8,6 +8,8 @@ Modular resources allow you to define custom components and services and add the For more information, see the [documentation](https://docs.viam.com/program/extend/modular-resources/). For a more complex example, take a look at the [complex module example](https://github.com/viamrobotics/viam-cpp-sdk/tree/main/src/viam/examples/modules/complex), which contains multiple new APIs and custom resource models. +For a fully fleshed-out example of a C++ module that uses Github CI to upload to the Viam Registry, take a look at [module-example-cpp](https://github.com/viamrobotics/module-example-cpp). For a list of example modules in different Viam SDKs, take a look [here](https://github.com/viamrobotics/upload-module/#example-repos). + ## Project structure The `main.cpp` file contains the definition of a new generic model and code to register it. It also has the optional validator function and implements reconfigure. The validator function is defined upon resource registration, and the reconfigure method is implemented on the resource class. diff --git a/src/viam/examples/modules/tflite/README.md b/src/viam/examples/modules/tflite/README.md index d74b42ea5..7f83c8a32 100644 --- a/src/viam/examples/modules/tflite/README.md +++ b/src/viam/examples/modules/tflite/README.md @@ -2,5 +2,7 @@ This example goes through how to create a custom audio classification modular resource using Viam's C++ SDK and TensorFlow Lite, and how to connect it to a Robot. Refer to main.cpp and the comments throughout for more information. For other C++ module examples, refer to the [simple module example](https://github.com/viamrobotics/viam-cpp-sdk/tree/main/src/viam/examples/modules/simple) or [complex module example](https://github.com/viamrobotics/viam-cpp-sdk/tree/main/src/viam/examples/modules/complex). +For a fully fleshed-out example of a C++ module that uses Github CI to upload to the Viam Registry, take a look at [module-example-cpp](https://github.com/viamrobotics/module-example-cpp). For a list of example modules in different Viam SDKs, take a look [here](https://github.com/viamrobotics/upload-module/#example-repos). + This is a limited document. For a more in-depth understanding of modules generally, see the [documentation](https://docs.viam.com/program/extend/modular-resources/).