| commit | 56d0b499459b1da5b8fe20b3df3fceb59835ce14 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue May 06 14:49:59 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue May 06 14:49:59 2025 -0700 |
| tree | 62e4ba39316573c52cb09da02425ccffa2f0ed7a | |
| parent | 89bd6a0e5a79ad0ac02f16f21d4d4c66f7044218 [diff] |
roll: third_party/pigweed a6dfe9f..1cb9ceb (5 commits) 1cb9ceb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289372 third_party/pico_sdk: Remove noisy TODOs 95bb7d2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289313 pw_ide: Replace hyphen in pigweed-vscode dir 8bdb9b2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287716 pw_kernel: Override target via platform 89063fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289052 pw_ide: Add `vsceLogin` command 10e0844:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289332 pw_clock_tree_mcuxpresso: Remove instance of dir_pw_third_party Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: a6dfe9f2462b0d..1cb9cebf0dfa22 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8715584993848045425 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I5cec37578a490050f080559ab3f5f9758ac9e4a3 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/289288 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
This repository outlines the recommended way of using Pigweed in a new or existing project. Feel free to fork this repository, or read it as a reference.
For more information see the Pigweed Getting started guide.
Check back for more complex examples and features coming soon!
Make sure you've set up Pigweed's prerequisites.
If you're on Windows, you can automate the initial setup by downloading the first-time setup script from cmd.exe:
curl https://pigweed.googlesource.com/pigweed/sample_project/+/main/tools/setup_windows_prerequisites.bat?format=TEXT > setup_pigweed_prerequisites.b64 && certutil -decode -f setup_pigweed_prerequisites.b64 setup_pigweed_prerequisites.bat && del setup_pigweed_prerequisites.b64
Then you can run the script with the following command in cmd.exe:
setup_pigweed_prerequisites.bat
Note: You may see a few UAC prompts as the script installs Git, Python, and enables developer mode.
Once that is done, you can clone this project with the following command:
git clone https://pigweed.googlesource.com/pigweed/sample_project
Pigweed uses a local development environment for most of its tools. This means tools are not installed to your machine, and are instead stored in a directory inside your project (Note: git ignores this directory). The tools are temporarily added to the PATH of the current shell session.
To make sure the latest tooling has been fetched and set up, run the bootstrap command for your operating system:
Windows
bootstrap.bat
Linux & Mac
source ./bootstrap.sh
After tooling updates, you might need to run bootstrap again to ensure the latest tools.
After the initial bootstrap, you can use use the activate scripts to configure the current shell for development without doing a full update.
Windows
activate.bat
Linux & Mac
source ./activate.sh
All of these commands must be run from inside an activated developer environment. See Environment setup
To build the project, documentation, and tests, run the following command in an activated environment:
pw build
Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:
pw watch
When you pull latest repository changes, run bootstrap:
source ./bootstrap.sh
If you're just launching a new shell session, you can activate instead:
source ./activate.sh
and rebuild with:
pw build
Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html.