# 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.