| commit | d34f68c2d567e52f6875836d95d1296a21b6bf1c | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Jul 15 20:00:25 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Jul 15 20:00:25 2024 +0000 |
| tree | 0548ba52195e34ddf901a483cd8cd7138f9ceeaa | |
| parent | 4a32f00983b6e3018e1ab7dab2906359794b65da [diff] |
roll: third_party/pigweed 8 commits a02745cb13e02e4 pw_ide: Create VSC settings interface cab84ef685196d2 pw_ide: Use VSC output panel for logging a830caebe3879e4 pw_ide: VSC extension cleanup 85f14eaec1d87a2 pw_thread: Add TestThreadContext for FreeRTOS f0ca09b6b258e75 pw_multibuf: Add more context on chunk regions d2185bd9f929dba pw_web: Save state on input change and adjust filt d984de91b2907d0 pw_rpc: Pass .proto files to compiler in Soong cf9b87778d83764 pw_transfer: Fix initial timeout and missing start https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: f81694520583467..a02745cb13e02e4 Roller-URL: https://ci.chromium.org/b/8742317884945592305 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I3d6c4653c67367437100b82532355a57a5c050f6 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/223232 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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.