| 1 | # Please browse the docs from either http://nrf24.github.io/RF24 |
| 2 | |
| 3 | ## Intended for use in Doxygen |
| 4 | |
| 5 | The markdown files (\*.md) in this docs folder contain relative hyperlinks. Any relative hyperlinks will not work when viewing these markdown files in github. |
| 6 | |
| 7 | ---- |
| 8 | |
| 9 | ## Building the docs |
| 10 | |
| 11 | Navigate to the repo's docs folder: |
| 12 | |
| 13 | ```shell |
| 14 | cd docs |
| 15 | ``` |
| 16 | |
| 17 | Install Doxygen (v1.12.0 or newer) and run the following command from the repo's docs folder: |
| 18 | |
| 19 | ```shell |
| 20 | doxygen |
| 21 | ``` |
| 22 | |
| 23 | The Doxygen HTML output is now in docs/html. |