blob: 935c171754643b065e12e864abb58e4dcfdd3b15 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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.
|