| commit | febbb7d4cd511c5e569b27025411b2e15dc061a2 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu Sep 05 19:02:49 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Sep 05 19:02:49 2024 +0000 |
| tree | d692abb32da2cb81346b715642f60b2dbf118228 | |
| parent | 3d30916cee070b0161a8739ed1e8d7752ef04e36 [diff] |
roll: third_party/pigweed 8 commits 196272619238281 pw_bluetooth_sapphire: Add testing Bazel unit test 7e9104fb19c00c3 pw_package: Fix pictotool install on mac 1eb09016e8bd33e pw_bluetooth_sapphire: Add sm Bazel unit test targ 1c6ecb99c9eb472 pw_bluetooth_sapphire: Add sdp Bazel unit test tar 1d6978a9f251c70 pw_bluetooth: Add LEAdvertisingSetTerminated event d726d01274174ab pw_bluetooth_sapphire: Add sco Bazel unit test tar 4fee7205aac81c2 pw_bluetooth: Format emboss files d06bb1cc4fa470d docs: Update bug reference to a public one https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 02e9f98073cc396..196272619238281 Roller-URL: https://ci.chromium.org/b/8737610467560823105 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I725745f80d289166aa146e0b55ea74ba7f2406cf Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/233967 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.