Skip to content

Commit

Permalink
updated
Browse files Browse the repository at this point in the history
  • Loading branch information
gigapod committed Aug 19, 2024
1 parent 88f3573 commit 2aca981
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ The repository contains a set of utilities, structured for use with the Raspberr

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.

The general pattern when using this library is:

* Copy the ```sparkfun_pico``` folder and all it's contents to your ```pico-sdk``` project directory.
* Update the projects ```CMakeList.txt``` file to add the ```sparkfun_pico``` sub-directory, and potentially *malloc/free wrap directives* outlined below.
* included the header file ```sparkfun_pico/sfe_pico.h``` in your projects source as needed.

### Add sparkfun_pico Library to a pico-sdk Project

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

## The sparkfun_pico API

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

### PSRAM detection

Expand Down

0 comments on commit 2aca981

Please sign in to comment.