Skip to content

Commit 96cad11

Browse files
committed
Update README.md to explain how to integrated to RasPi Pico project.
1 parent f382e15 commit 96cad11

1 file changed

Lines changed: 27 additions & 8 deletions

File tree

README.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ This class collection ( or class library ) encapsule the certain data inside cla
88

99
These classes are provided in this version.
1010

11-
| class | Description |
12-
|--------------------------------- |----------------------------- |
13-
| ::rpp_driver::SdkWrapper | Wrapper class of Pico SDK |
14-
| ::rpp_driver::GpioBasic | Basic GPIO controller |
15-
| ::rpp_driver::I2cMaster | I2C Master controller |
16-
| ::rpp_driver::I2sSlaveDuplex | Polling based PIO I2S driver |
17-
| ::rpp_driver::Adau1361 | Audio CODEC driver |
11+
| Class | Header file | Description |
12+
|---------------------------------|---- |----------------------------- |
13+
| ::rpp_driver::SdkWrapper | sdkwrapper.hpp | Wrapper class of Pico SDK |
14+
| ::rpp_driver::GpioBasic | gpiobasic.hpp | Basic GPIO controller |
15+
| ::rpp_driver::I2cMaster | i2cmaster.hpp | I2C Master controller |
16+
| ::rpp_driver::I2sSlaveDuplex | i2sslaveduplex.hpp | Polling based PIO I2S driver |
17+
| ::rpp_driver::Adau1361 | adau1361.hpp | Audio CODEC driver |
18+
| ::rpp_driver::UmbAdau1361Lower | umbadau1361lower.hpp | CODEC lower driver dedicated to UMB-ADAU1361-A board |
1819

1920

2021
## How to obtain this project
@@ -62,7 +63,7 @@ cmake --build build --config Debug --target all
6263
```
6364

6465
## Building document
65-
An API document are provided by HTML files.
66+
An API document is provided as HTML files.
6667
To obtain it, run doxygen at the project root ( where the README.md exists).
6768

6869
```sh
@@ -71,6 +72,24 @@ doxygen
7172

7273
The documentation will be generated under the docs/html/ subdirectory.
7374

75+
# Integration to your RasPi Pico project
76+
To use the rpp_driver, as a first step, you need to add following lines into your CMakeLists.txt.
77+
78+
```
79+
add_subdirectory(rpp_driver)
80+
```
81+
82+
```
83+
target_link_libraries(${PROJECT_NAME} pico_stdlib
84+
hardware_i2c
85+
hardware_pio
86+
rpp_driver)
87+
```
88+
89+
Note : Whichever you use PIO/I2C or not, you need to link these libraries.
90+
91+
By linking library, the include path for the include files are set automatically.
92+
7493
# License
7594
This project is provided under [MIT License](LICENSE).
7695

0 commit comments

Comments
 (0)