| commit | 2afe73dc010c9c2b5f8d402174ae24a8d6575cd9 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Fri Jul 19 19:48:59 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri Jul 19 19:48:59 2024 +0000 |
| tree | 17be3bbc1ff3a880ed69754f8af3e65eb28e69dd | |
| parent | b74682d12a998ee061b481bfd57e0cb0db48ffc6 [diff] |
roll: third_party/pigweed 8 commits f6c4828aa0db15b pw_transfer: Don't block indefinitely on events 9a827f5f037f6b0 pw_rpc_transport: Don't write empty header in Stre f4e1dbc0aafcd5c bazel: Organize and document required flags 7cdc947ebadf0f9 pw_sensor: Add units to sensor::channels final out 9ed247fb40dbdf6 pw_console: Add config option for log message reco f3a52277083c515 pw_bluetooth_proxy: Do not pass on NOCP events wit a3dac2f97ae68a9 pw_bluetooth_proxy: Have functions handle passing 2e8949d2187a7e5 pw_bluetooth_proxy: Update tests to verify number https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: e45ec8f7c2d1e77..f6c4828aa0db15b Roller-URL: https://ci.chromium.org/b/8741956206452921649 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I2f57cff5fd6c9015fc23ff0ae0de1a67949d177a Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/224891 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: 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.