|author||Armando Montanez <email@example.com>||Tue Sep 26 18:49:04 2023 +0000|
|committer||Copybara-Service <firstname.lastname@example.org>||Tue Sep 26 11:49:40 2023 -0700|
Ameliorate device-sim race Give the simulated device a moment to start up and serve on the expected port to prevent a race where the console tries to connect before the port is ready. Change-Id: Ib696a96125a7b60cd06805db760f66d5c21a8ce8 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/sample_project/+/172911 Pigweed-Auto-Submit: Armando Montanez <email@example.com> Reviewed-by: Taylor Cramer <firstname.lastname@example.org> Commit-Queue: Auto-Submit <email@example.com> Presubmit-Verified: CQ Bot Account <firstname.lastname@example.org> GitOrigin-RevId: aa636003df062a2880236e3ed56f8622ea9c727f
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:
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:
Linux & Mac
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.
Linux & Mac
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:
Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use
When you pull latest repository changes, run bootstrap:
If you're just launching a new shell session, you can activate instead:
and rebuild with:
Extended documentation and examples are built along code changes. You can view them at