Skip to content

Switch to Ninja and add README #53

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.

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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Switch to Ninja and add README #53

wants to merge 4 commits into from

Conversation

will-v-pi
Copy link
Contributor

Install Ninja and switch the pico-examples build over to that, so you get automatic multithreading without -j giving simpler command line instructions, and a shorter build output.

Add a README which:

  • Explains the purpose of the script & how to run it
  • Mentions VS Code extension as the way to go if you want a GUI
  • Includes some quick Getting Started bits for command line compilation
  • Adds basic command line setup instructions for other OSes that can't use the script (including mentioning that Linux with apt should work with the script)

will-v-pi added 2 commits June 4, 2025 17:58
Also build for W picos as well
Adds some simple command line instructions, along with basic setup instructions for other OSes that can't use this script
@will-v-pi will-v-pi requested a review from lurch June 6, 2025 14:13

For more details on debugging with GDB, see the [GDB docs](https://sourceware.org/gdb/current/onlinedocs/gdb.html/)

## Multiple Terminals

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this really something we should include? won't most people just open multiple terminal instances?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this script is to support Raspberry Pi OS Lite (as VS Code can be used everywhere else), I wanted to include how to have multiple terminals on that

cd pico/pico-examples
```

Depending on the board you're using (eg pico2), replace `build_pico` with the relevant build directory (eg `build_pico2`) in the following commands.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about this advice to create a board-specific build directory - IIRC we've never done that elsewhere in any of our other documentation?
(also, I suspect the vast majority of people will only have a single board and/or single type of board?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This recommendation was to follow how the script works (which uses board specific build directories), as then you can follow the instructions above exactly. Also, it avoids the need to say that you need to delete build directories when switching between Pico and Pico 2, but not Pico and Pico W

@lurch
Copy link
Contributor

lurch commented Jun 7, 2025

This expanded documentation is great; but in order to avoid duplication of effort, I wonder if it might be better to add it to https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf instead and then have this README.md point people to that? 🤔

@will-v-pi
Copy link
Contributor Author

This expanded documentation is great; but in order to avoid duplication of effort, I wonder if it might be better to add it to https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf instead and then have this README.md point people to that? 🤔

I think I want to put the command line Getting Started here instead - that document should really focus on VS Code for getting started, as that's the easiest way to get set up (if you have a GUI). It also means the script and the documentation are in the same place, so they're easier to keep in sync.

@lurch
Copy link
Contributor

lurch commented Jun 9, 2025

I think I want to put the command line Getting Started here instead - that document should really focus on VS Code for getting started

Fair enough; as long as there's no duplication of documentation, and each place points to where "the other thing" is documented, I think I'm happy 🙂

@will-v-pi will-v-pi requested a review from kilograham June 11, 2025 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants