| commit | ea3164169b37447c0e3318aa39d646a69474cdc0 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Jan 13 16:34:15 2025 -0800 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Jan 13 16:34:15 2025 -0800 |
| tree | 21e314a772adc670ebfa2fd7984756e5db17fcba | |
| parent | 678a20adea3b197af24005f20182a88d95e2ab42 [diff] |
roll: third_party/pigweed ef30932..a8f3d5e (6 commits) a8f3d5e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260193 docs: Add showcases index to Bazel build 2f4c98a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/259353 docs: Standardize CLI code block styling 9735377:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260232 docs: Fix blog post titles 6053b3c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/259293 pw_build: Update comments around pigweed.bazelrc 00f6395:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260058 pw_watch: Create //:watch alias to //pw_watch/py:bazel f41ac14:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/259656 pw_ide: Read compDBs from legacy dir Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: ef30932cbddbbe..a8f3d5ebc9b17f Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8725812134574932033 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I6d0b1c3055f23d09cac0499540f2475b3dbdaf39 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/260154 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.