Skip to content
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

Add note about pico-sdk-tools to README.md #146

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

Add note about pico-sdk-tools to README.md #146

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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Building

> If you don't need to build picotool yourself, you can find pre-built binaries for Windows, macOS, and Linux in the [pico-sdk-tools](https://github.com/raspberrypi/pico-sdk-tools/releases) repository
Copy link
Contributor

Choose a reason for hiding this comment

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

"If you don't need..." sounds a bit strange - why would anybody need to build picotool themselves? 😉

Perhaps this could be shortened to something like "Pre-built binaries of picotool for Windows, macOS, and Linux can be downloaded from the pico-sdk-tools repository. But if you want to build it yourself from source..."

Hmm, it's obviously a slightly larger change, but given that we are now offering pre-built binaries, perhaps the "Building" section should come after the "Overview" section? Or perhaps be moved to an entirely separate BUILDING.md file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that keeping the Building and Usage by the SDK sections at the top is useful, as the Overview is very long and therefore people might miss the build instructions, which would probably create more issues.

"If you don't need..." sounds a bit strange - why would anybody need to build picotool themselves? 😉

You might not trust binaries you've downloaded from the internet, or you might want to install picotool system-wide - both of these would require building it yourself, although maybe "If you don't want..." would be better phrasing? I think it's still the main use case for people who arrive at this repository, and building it from source should work fine across all platforms - it works fine on Windows for me

Copy link
Contributor

Choose a reason for hiding this comment

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

Fair enough. But perhaps it's worth having a brief "Introduction" or "Description" at the top of README.md, rather than diving straight into "Building" on the very first line? 🤷


You need to set PICO_SDK_PATH in the environment, or pass it to cmake with `-DPICO_SDK_PATH=/path/to/pico-sdk`. To use features such as signing or hashing, you will need to make sure the mbedtls submodule in the SDK is checked out - this can be done by running this from your SDK directory.

```console
Expand Down
Loading