Skip to content

Commit 2aca981

Browse files
committed
updated
1 parent 88f3573 commit 2aca981

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

Diff for: README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ The repository contains a set of utilities, structured for use with the Raspberr
66

77
A majority of the functionality outlined in this repository is contained in the folder ```sparkfun_pico```. This folder is structured as a ```cmake``` library, ready for use by the ```pico-sdk``` build environment.
88

9+
The general pattern when using this library is:
10+
11+
* Copy the ```sparkfun_pico``` folder and all it's contents to your ```pico-sdk``` project directory.
12+
* Update the projects ```CMakeList.txt``` file to add the ```sparkfun_pico``` sub-directory, and potentially *malloc/free wrap directives* outlined below.
13+
* included the header file ```sparkfun_pico/sfe_pico.h``` in your projects source as needed.
14+
915
### Add sparkfun_pico Library to a pico-sdk Project
1016

1117
To use the library as part of the cmake build process of the ```pico-sdk```, perform the following:
@@ -83,7 +89,7 @@ cmake .. -DPICO_BOARD=sparkfun_promicro_rp2350
8389

8490
## The sparkfun_pico API
8591

86-
The sparkfun_pico library supports the following functions:
92+
The sparkfun_pico library supports the following functions, with function signatures declared in [sparkfun_pico/sfe_pico.h](sparkfun_pico/sfe_pico.h):
8793

8894
### PSRAM detection
8995

0 commit comments

Comments
 (0)