Skip to content

Commit 09dfd10

Browse files
author
jiri.strouhal
committed
Link the main README and the documentation
1 parent e7b48b4 commit 09dfd10

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ This is the implementation of Example module. Repo contains example_module libra
33
This module serves as an example for module maintainers to implement their own modules outside reserved range of modules. It is not intended to be used in production.
44
Module number of this module is 1000.
55

6+
For more details on the module, see [module documentation](./docs/module_documentation_template.md).
7+
68
# Requirements
79

810
- fleet protocol library - [v2.0.0](https://github.com/bringauto/fleet-protocol/releases/tag/v2.0.0)

docs/module_documentation_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- Provide a single sentence or a short paragraph describing the module's purpose. When using the documentation inside repository, add link to the README and vice versa - link the README to this documentation. -->
44

5-
This module serves as an example for module maintainers to implement their own modules outside reserved range of modules and does not serve any role in the production environment.
5+
This module serves as an example for module maintainers to implement their own modules outside reserved range of modules and does not serve any role in the production environment. For usage of this module, see the [README](../README.md).
66

77
# Identification and supported devices
88

0 commit comments

Comments
 (0)