summaryrefslogtreecommitdiff
path: root/.pio/libdeps/esp32-s3-n16r8/RF24/docs/README.md
diff options
context:
space:
mode:
authorkrolyxon <me@krolyxon.com>2026-06-08 23:10:46 +0530
committerkrolyxon <me@krolyxon.com>2026-06-08 23:10:46 +0530
commit3120783000d0025b183b0397acaa8b769499eb38 (patch)
tree1c4f93be213f1b1d48f59e554562d847b4e7c25e /.pio/libdeps/esp32-s3-n16r8/RF24/docs/README.md
Initial gh-pages firmware hosting
Diffstat (limited to '.pio/libdeps/esp32-s3-n16r8/RF24/docs/README.md')
-rw-r--r--.pio/libdeps/esp32-s3-n16r8/RF24/docs/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/.pio/libdeps/esp32-s3-n16r8/RF24/docs/README.md b/.pio/libdeps/esp32-s3-n16r8/RF24/docs/README.md
new file mode 100644
index 0000000..935c171
--- /dev/null
+++ b/.pio/libdeps/esp32-s3-n16r8/RF24/docs/README.md
@@ -0,0 +1,23 @@
+# Please browse the docs from either http://nrf24.github.io/RF24
+
+## Intended for use in Doxygen
+
+The markdown files (\*.md) in this docs folder contain relative hyperlinks. Any relative hyperlinks will not work when viewing these markdown files in github.
+
+----
+
+## Building the docs
+
+Navigate to the repo's docs folder:
+
+```shell
+cd docs
+```
+
+Install Doxygen (v1.12.0 or newer) and run the following command from the repo's docs folder:
+
+```shell
+doxygen
+```
+
+The Doxygen HTML output is now in docs/html.