Google Git
Sign in
pigweed / pigweed / examples / a3fa0499cc01c02c7cf79251279283f14d24334e
commita3fa0499cc01c02c7cf79251279283f14d24334e[log] [tgz]
authorAnthony DiGirolamo <tonymd@google.com>Wed Sep 13 16:41:15 2023 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Sep 13 16:41:15 2023 +0000
tree3511361139f0fb2ea85857b56d4db1586b9b2e7d
parentdce5df8f47ffb45eddc282fc6bca428f489ae3b3 [diff]
RP2040 Target with pw_system

Requires: pigweed:170770
Change-Id: Id21d598d8ab0e0c050028582e10f1783dc62e2dc
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/sample_project/+/170634
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Commit-Queue: Anthony DiGirolamo <tonymd@google.com>
Reviewed-by: Armando Montanez <amontanez@google.com>
6 files changed
tree: 3511361139f0fb2ea85857b56d4db1586b9b2e7d
  1. build_overrides/
  2. docs/
  3. examples/
  4. images/
  5. infra/
  6. libraries/
  7. targets/
  8. third_party/
  9. tools/
  10. .clang-format ⇨ third_party/pigweed/.clang-format
  11. activate.sh ⇨ bootstrap.sh
  12. .gitattributes
  13. .gitignore
  14. .gitmodules
  15. .gn
  16. activate.bat
  17. banner.txt
  18. bootstrap.bat
  19. bootstrap.sh
  20. BUILD.gn
  21. BUILDCONFIG.gn
  22. LICENSE
  23. navbar.md
  24. OWNERS
  25. pigweed.json
  26. pyproject.toml
  27. README.md
README.md

Pigweed Sample Project

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!

Getting started

Make sure you've set up Pigweed's prerequisites. Once that is done, you can clone this project and all required git submodules with the following command:

git clone --recursive https://pigweed.googlesource.com/pigweed/sample_project

If you already cloned but forgot to include --recursive, run git submodule update --init to pull all submodules.

Environment setup

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

Building

All of these commands must be run from inside an activated developer environment. See Environment setup

One-shot build

To build the project, documentation, and tests, run the following command in an activated environment:

pw build

Automatically build on file save

Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:

pw watch

Typical workflow

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

More info and Examples

Extended documentation and examples are built along code changes. You can view them at out/docs/gen/docs/html/index.html.