cs-midi-docs/docs/01-getting-started/installation.md

34 lines
740 B
Markdown

# Installation
## Prerequisites
- [pico-sdk](https://github.com/raspberrypi/pico-sdk) (v2.0+)
- CMake 3.13+
- ARM GCC toolchain
## Adding to your project
Add cs-midi as a git submodule:
```bash
git submodule add https://git.else-if.org/jess/cs-midi.git lib/cs-midi
```
In your `CMakeLists.txt`:
```cmake
add_subdirectory(lib/cs-midi)
target_link_libraries(your_target cs_midi)
target_include_directories(cs_midi PRIVATE ${CMAKE_CURRENT_LIST_DIR})
```
The last line is required so cs-midi can find your project's `btstack_config.h` and `lwipopts.h`.
## Include
```cpp
#include <cs_midi.h>
```
This single header pulls in everything: output elements, input elements, pipes, banks, BLE interface, and the Control Surface singleton.