summaryrefslogtreecommitdiffstats
path: root/libraries/libcoap/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/libcoap/README')
-rw-r--r--libraries/libcoap/README5
1 files changed, 5 insertions, 0 deletions
diff --git a/libraries/libcoap/README b/libraries/libcoap/README
index 676011c62e..6ecdf3944d 100644
--- a/libraries/libcoap/README
+++ b/libraries/libcoap/README
@@ -2,3 +2,8 @@ libcoap implements a lightweight application-protocol for devices
that are constrained in their resources such as computing power,
RF range, memory, bandwith, or network packet sizes.
This protocol, CoAP, was standardized in the IETF as RFC 7252.
+
+By default, the API documentation is not built, as it's rather
+resource-intensive, and not required unless you're a developer. If
+you need the API docs, install graphviz, then run this build with
+APIDOC=yes in the environment.