| commit | 5c6dc3983ba473b1015bcf916ebc8130245e6744 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Feb 11 14:59:02 2025 -0800 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Feb 11 14:59:02 2025 -0800 |
| tree | b64ea200d4b493b2cb86d61fd9560a25cfe925ae | |
| parent | f86e537d06f9842637a61ce0de64b34fef14e51c [diff] |
roll: third_party/pigweed a3ebd8f..63fde05 (6 commits) 63fde05:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/267232 pw_kernel: Add cheat sheet docs 6aeb739:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266272 pw_bluetooth_sapphire: Wait for BR/EDR pairing to complete in SM 0a223d3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266912 pw_bloat: Add Bazel size report rule for single binary f85f008:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/267015 pw_rust: Add --config support to gen_rust_project f5ee80b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/267014 pw_toolchain: Adjust stable Rust toolchain to work with gen_rust_project 7892387:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/267192 pw_build: Clean up docs headings Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: a3ebd8ff20a81e..63fde0590b256a Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8723190978150939377 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ic6b24c0b06ef8a13748d66b5ee02c3991ca7cf66 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/267352 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.