Skip to content

Update build commands in README #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hayaokimura wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update build commands in README #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ R2P2 uses dual CDC (Communications Device Class) USB ports to separate standard
- **CDC 0** (in Linux, typically `/dev/ttyACM0`): Main terminal for shell interaction and application stdout
- **CDC 1** (as in, `/dev/ttyACM1`): Debug output (stderr) for system messages and debug prints

Debug output is only enabled in debug builds (`rake debug` or `PICORUBY_DEBUG=1 rake`).
Debug output is only enabled in debug builds (e.g., `rake picoruby:pico:debug`).

To view debug output:
```sh
Expand Down Expand Up @@ -129,15 +129,20 @@ brew install --cask gcc-arm-embedded
git clone https://github.com/picoruby/R2P2.git
cd R2P2
rake setup
rake
rake picoruby:pico:prod
```

You'll find an executable in `build` directory.

For other boards, use:
- `rake picoruby:pico_w:prod` (Pico W)
- `rake picoruby:pico2:prod` (Pico 2)
- `rake picoruby:pico2_w:prod` (Pico 2 W)

### Debug build

```
rake debug
rake picoruby:pico:debug
```

The elf file can be debugged with Picoprobe and gdb-multiarch.
Expand Down