Skip to content

Commit 97f1e83

Browse files
committed
docs: This README focuses on:
- Quick setup steps - Essential project structure - Key configuration points - Basic debugging
1 parent 0841be9 commit 97f1e83

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Development Setup Guide
2+
3+
This project uses arduino-pico core for debugging RP2040-based Arduino Pico programs with local modifications.
4+
5+
## Prerequisites
6+
7+
- [Arduino Pico](https://github.com/earlephilhower/arduino-pico) core
8+
- [PlatformIO](https://platformio.org/)
9+
- CMSIS-DAP compatible debug probe
10+
11+
## Setup Process
12+
13+
1. Clone those repositories:
14+
```bash
15+
git clone https://github.com/schkovich/arduino-pico.git
16+
cd arduino-pico
17+
git checkout execute-sync@7c51742
18+
git submodule update --init
19+
cd ..
20+
git clone [email protected]:schkovich/pico-sdk-tests.git
21+
cd pico-sdk-tests
22+
```
23+
24+
## Project Structure
25+
```plaintext
26+
27+
├── arduino-pico # Forked arduino-pico core
28+
├── pico-sdk-tests
29+
│   ├── lib
30+
│   ├── .pio # PlatformIO build directory
31+
│   ├── scripts # Debug scripts
32+
│   └── src
33+
```
34+
35+
## Project configuration
36+
The arduino-pico core is configured in [platformio.ini](https://docs.platformio.org/en/latest/projectconf/index.html#platformio-ini-project-configuration-file) via [platform_package](https://docs.platformio.org/en/latest/projectconf/sections/env/options/platform/platform_packages.html#platform-packages) option, pointing to the [local folder](https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#local-folder) and “Symbolic Link” feature:
37+
```ini
38+
[env:debug]
39+
board = nanorp2040connect
40+
framework = arduino
41+
platform = https://github.com/maxgerhardt/platform-raspberrypi.git
42+
board_build.core = earlephilhower
43+
platform_packages =
44+
framework-arduinopico@symlink://../arduino-pico
45+
```
46+
## Building Core Components
47+
The pico-sdk build process:
48+
49+
1. Compiles core SDK libraries
50+
2. Generates boot stage 2 code for different flash chips
51+
3. Produces required build artifacts for both RP2040 and RP2350
52+
53+
For detailed build steps, see [make-libpico.sh](https://github.com/schkovich/arduino-pico/blob/execute-sync%407c51742/tools/libpico/make-libpico.sh) in the arduino-pico core.
54+
55+
### Development Workflow
56+
57+
- Pico SDK and async_context are pre-built statically linked to the project
58+
- The project is built using [PlatformIO](https://docs.platformio.org/en/latest/core/index.html)
59+
- Debug using CMSIS-DAP probe

0 commit comments

Comments
 (0)