Skip to content

Commit 8a60553

Browse files
authored
Update README.md (#855)
1 parent 014afab commit 8a60553

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

examples/simple_module/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
# VIAM Simple Module Example
2-
This example goes through how to create custom modular resources using Viam's python SDK, and how to connect it to a Robot.
1+
# Viam Simple Module Example
2+
This example goes through how to create custom modular resources using Viam's Python SDK, and how to connect it to a machine.
33

44
This is a limited document. For a more in-depth understanding of modules, see the [documentation](https://docs.viam.com/operate/get-started/other-hardware/).
55

6+
> [!NOTE]
7+
> You can auto-generate the stub files for your module using the Viam CLI.
8+
> [Install the CLI and authenticate](https://docs.viam.com/dev/tools/cli/#install), then run `viam module generate` and follow the prompts.
9+
610
## Purpose
7-
Modular resources allow you to define custom components and services, and add them to your robot. Viam ships with many component types, but you're not limited to only using those types -- you can create your own using modules.
11+
Modular resources allow you to define custom components and services, and add them to your robot. Viam ships with many component models, but you're not limited to only using those models -- you can add support for other models of hardware and software using modules.
812

913
For more information, see the [documentation](hhttps://docs.viam.com/operate/get-started/other-hardware/). For a more complex example, take a look at the [complex module example](https://github.com/viamrobotics/viam-python-sdk/tree/main/examples/complex_module), which contains multiple new APIs and custom resource models.
1014

0 commit comments

Comments
 (0)