| commit | 98ba1d3b9d6e41fb7d325b38fa609b48ef5062b1 | [log] [tgz] |
|---|---|---|
| author | Jonathon Reinhart <jrreinhart@pigweed.infra.roller.google.com> | Thu Jul 25 22:29:55 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Jul 25 22:29:55 2024 +0000 |
| tree | 72829908a75be8a054898684cb78f46594f14713 | |
| parent | c820598dcee8155a26072c2553cdb31a646e43bb [diff] |
roll: pigweed, pw_toolchain: pw_async2: Fix minor doc issues It turns out using code backticks in a markdown header, in a Doxygen class comment, in an RST document doesn't quite work right. This: /// # Using `co_await` Resulted in <tt>co_await</tt> being visible in the final rendered doc. Just remove the backticks rather than trying to unwind that stack. Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/226111 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> https://pigweed.googlesource.com/pigweed/pigweed pigweed, pw_toolchain Rolled-Commits: 0792e045ef9cc27..cb5ee68a68c2c3c Roller-URL: https://ci.chromium.org/b/8741401927843317937 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I8ec9e35f370a218265fcf0369afb551d50ffda8e Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/226022 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 contains a minimal example of a Bazel-based Pigweed project. It's an echo application for the STM32F429 Discovery Board.
git clone --recursive https://pigweed.googlesource.com/pigweed/quickstart/bazel
If you already cloned but forgot to include --recursive, run git submodule update --init to pull all submodules.
TODO: b/300695111 - Don't require submodules for this example.
We‘ll assume you already have Bazel on your system. If you don’t, the recommended way to get it is through Bazelisk.
To build the entire project (including building the application for both the host and the STM32 Discovery Board), run
bazel build //...
To run the application locally on your machine, run,
bazel run //src:echo
To flash the firmware to a STM32F429 Discovery Board connected to your machine, run,
bazel run //tools:flash
Note that you don't need to build the firmware first: Bazel knows that the firmware images are needed to flash the board, and will build them for you. And if you edit the source of the firmware or any of its dependencies, it will get rebuilt when you flash.
Run,
bazel run //tools:miniterm -- /dev/ttyACM0 --filter=debug
to communicate with the board. When you transmit a character, you should get the same character back!