| commit | 1045dd467020a8d48fab3e47bd04291330edc0a0 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Wed Jul 31 19:13:44 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Jul 31 19:13:44 2024 +0000 |
| tree | 99b1325bdc0b81a12359ca15ef7b2598080e01d5 | |
| parent | 5cb1f1417e440a6abaca88d22bf0da3c9e672597 [diff] |
roll: third_party/pigweed 8 commits 93c2ec369ab5a18 pw_console: Bump version of console js, add titles 8f276075de78ca5 pw_web: NPM version bump to 0.0.21 116b67dbec88d7b bazel: Manage Java deps through bzlmod 9b9615e17801148 pw_presubmit: Add new presubmit steps 285805a35a9878a pw_web: Enable custom titles, log-view access 71a9d5447de318e docs: Fix some bad links in the changelog 40caf32b68cf760 third_party/stm32cube: bzlmod-friendly changes df07efa092d4072 pw_rpc: Add yield mode constraint_setting https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: b454ef6a4541f4f..93c2ec369ab5a18 Roller-URL: https://ci.chromium.org/b/8740871280159102961 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I7f0679b651f12040f4740e78a1275dd469a60331 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/226894 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> 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.