Skip to content

Commit ee2756e

Browse files
README: Point to doxygen documentation
1 parent 207bf46 commit ee2756e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ library](https://www.arduino.cc/reference/en/libraries/mkrwan/)
1212
library should usually work on the other too (but note below for some
1313
caveats).
1414

15+
## Documentation
16+
Overview and reference documentation is embedded in the source code.
17+
Fully generated documentation will be published later, for now you can
18+
generate it yourself using the [Doxygen](https://doxygen.nl/) tool.
19+
20+
To generate the documentation yourself, simply run the `doxygen` command
21+
(no options needed) in the root of this repository. This will produce
22+
HTML documentation in the `api-docs` subdirectory.
23+
1524
## License
1625
This library is based on LoRaMac-node developed by semtech, with
1726
extensive modifications and additions made by STMicroelectronics.

0 commit comments

Comments
 (0)