| commit | e8a1edc26cf861251ee9cb5a58f99f08348d6913 | [log] [tgz] |
|---|---|---|
| author | Anthony DiGirolamo <tonymd@google.com> | Tue Sep 12 21:28:26 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Sep 12 21:28:26 2023 +0000 |
| tree | 1fd593d317e8db0a4a907bcbb63b3c8a6a38149d | |
| parent | be1ec53609822e9a6749266925e127ff1f522929 [diff] |
Rename target stm32f429i_disc1 to stm32f429i_disc1_stm32cube Change-Id: Icea071bac826ad3fe5efcf1b253fe20cad9c77e5 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/sample_project/+/170633 Commit-Queue: Anthony DiGirolamo <tonymd@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. 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.
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/docs/gen/docs/html/index.html.