| commit | adf0c67a4f59a45d4a968a6239f573e67ab7dd26 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu Aug 01 01:12:59 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Aug 01 01:12:59 2024 +0000 |
| tree | e3f1402c0972b9fd6676591b70ef9faa8ab740d0 | |
| parent | 3c226ff7c17536c79e9b8489f8a1e0bd6888bf6e [diff] |
roll: third_party/pigweed 5 commits 61f6e54585a0e81 pw_rust: Add no_std build to basic_executable 79f0dd143867866 pw_rust: Rename host_executable 9d49c47bb21b0cc pw_env_setup: Add rustc thumbv7m target 55c5087185c0ff3 pw_tokenizer: decode_optionally_tokenized without 280aeccf0bef690 pw_console: Additional UI and code themes https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 5cb019aed9d68b2..61f6e54585a0e81 Roller-URL: https://ci.chromium.org/b/8740848678151888353 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I0c3ee9f8129c9576e6cf6834c7718d3fab03c35f Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/226856 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.