README.md
1# nrfx
2
3## Overview
4
5nrfx is a standalone set of drivers for peripherals present in Nordic
6Semiconductor's SoCs. It originated as an extract from the nRF5 SDK.
7The intention was to provide drivers that can be used in various environments
8without the necessity to integrate other parts of the SDK into them.
9For the user's convenience, the drivers come with the MDK package. This package
10contains definitions of register structures and bitfields for all supported
11SoCs, as well as startup and initialization files for them.
12
13## Supported SoCs
14
15* nRF51 Series
16* nRF52805
17* nRF52810
18* nRF52811
19* nRF52820
20* nRF52832
21* nRF52833
22* nRF52840
23* nRF5340
24* nRF9160
25
26## Directories
27
28```
29 .
30 ├── doc # Project documentation files
31 ├── drivers # nrfx driver files
32 │ ├── include # nrfx driver headers
33 │ └── src # nrfx driver sources
34 ├── hal # Hardware Access Layer files
35 ├── helpers # nrfx driver helper files
36 ├── mdk # nRF MDK files
37 ├── soc # SoC specific files
38 └── templates # Templates of nrfx integration files
39```
40
41## Generating documentation
42
43nrfx documentation is available in the `doc\html` folder of the release package.
44
45You can also generate documentation yourself from the source code. To do it, install doxygen
46and run one of the scripts: `generate_html_doc.bat` or `generate_html_doc.sh`. Generated
47documentation will be stored in the `doc\html` directory. Use `index.html` to open it.
48