commit | b74d9b54b875ed2ed22622ac19e67a8c8321e6d4 | [log] [tgz] |
---|---|---|
author | Ted Pudlik <tpudlik@google.com> | Mon Mar 11 16:57:41 2024 +0000 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Mar 11 16:57:41 2024 +0000 |
tree | e3301a2d13804041a1e719003fa0d36a407eb1cc | |
parent | 143e0fc6fffa2542c3fa2992c6180fa1616e4e88 [diff] |
Get example 01 console to work This requires renaming the example directories so that they don't contain hyphens, because py_proto_library doesn't support generating code for protos in directories with hyphens in their names. See https://github.com/bazelbuild/rules_python/blob/da10ac49efee1b02cbfa3b22a39e68bf3fe5bbe2/python/private/proto/py_proto_library.bzl#L60 Also a few small fixes needed to get it all to work: * Add a dep on arm_none_eabi_gcc_support to the binary to silence some warnings. * Upgrade protobuf version to match upstream. * Add bazel CIPD package to environment. Test: bazel build //... Test: bazel run //examples/01-blinky:console Bug: 307825072 Change-Id: I1c1bdafe4059bae78ed3e5ea5f7d5cadb43e43d5 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/195128 Commit-Queue: Ted Pudlik <tpudlik@google.com> Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Armando Montanez <amontanez@google.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
.