-
Notifications
You must be signed in to change notification settings - Fork 48
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
base: master
Are you sure you want to change the base?
Conversation
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
|
||
For more details on debugging with GDB, see the [GDB docs](https://sourceware.org/gdb/current/onlinedocs/gdb.html/) | ||
|
||
## Multiple Terminals |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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?)
There was a problem hiding this comment.
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
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. |
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 🙂 |
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:
apt
should work with the script)