| commit | 6b99df1cdde74e5a940f46a97c8072f33fda49e3 | [log] [tgz] |
|---|---|---|
| author | Kayce Basques <kayce@pigweed.infra.roller.google.com> | Fri Aug 08 10:44:03 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri Aug 08 10:44:03 2025 -0700 |
| tree | c7461c12626c12ea84b234805512f07174daccc5 | |
| parent | 575b277a7b96e399f13e1faf11e72e7c6630fb81 [diff] |
roll: third_party/pigweed doxygen: Link to main site * Clicking the site logo or site title links you back to the main site * The main site is now mentioned on the home page Original-Bug: 426012010 Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311322 Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Original-Revision: 91cfc6e5a7cb9e7e7130a9964d51a99dbf261823 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 2b23689560196e..91cfc6e5a7cb9e Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8707084371004469745 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ie510f6c2be1bdd105e980e9051072787f29c5d9f Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/311199 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Bot-Commit: 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.