roll: third_party/pigweed 81d1b0e..096dff1 (9 commits) 096dff1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/468065 doxygen: Demonstrate snippets ac2148a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/381039 pw_allocator: Add FramingAllocator 5bdc1c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/474105 docs: Fix miscellaneous issues in new UI 2e5d536:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/473245 docs: Add breadcrumbs 83bb188:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/467905 docs: Integrate navs 6ab18d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/456609 docs: Start theme selector c7c4172:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/456608 docs: Update search ec6a097:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/461365 docs: Start tests fdc232b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/456607 docs: Start header Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 81d1b0ee0843a7..096dff1b26750e Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8670923968111845921 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I74f0edad66eb80973747b3710c1cdfe950efaca5 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/475085
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/examples/+/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/examples
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.