| commit | 12449929b88e4a05c31997de4185cb94fc3c3e51 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed.infra.roller.pigweed-service-accounts.iam.gserviceaccount.com> | Sun May 25 16:55:08 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Sun May 25 16:55:08 2025 -0700 |
| tree | c5da856617f5be93fd1726567a6274479599c62a | |
| parent | fe5f5d1906eed6a39c7cfa4e9e61fd146f1c788e [diff] |
roll: third_party/pigweed roll: gn From git_revision:0c25d1bbde6ef17e1e6d3938011f56a00c02e457 To git_revision:ebc8f16ca7b0d36a3e532ee90896f9eb48e5423b Roll-Count: 1 GitWatcher: ignore Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294159 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Original-Revision: 4be0d002f0f5f1392e57885f3c3a6680e434c620 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: d34b1d1996f905..4be0d002f0f5f1 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8713855872741693553 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I25b711e8fafb835ab10756dadd789e0b5cc4e923 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/294234 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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.