roll: pw_toolchain, pw_toolchain: docs: Update GitHub actions tutorial

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/216276
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>

https://pigweed.googlesource.com/pigweed/pigweed
pw_toolchain, pw_toolchain Rolled-Commits: 6411cd88cf8cd7c..3a1996034e63dea
Roller-URL: https://ci.chromium.org/b/8744824348354588705
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I6e2b30c27ab95509ce71a91d070aa12b28917f15
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/216571
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>
1 file changed
tree: a82f6900888f6b9c82c290c468678dec217072ee
  1. .github/
  2. src/
  3. targets/
  4. tools/
  5. .bazelrc
  6. .bazelversion
  7. .gitignore
  8. BUILD.bazel
  9. echo.bzl
  10. LICENSE
  11. pigweed.json
  12. README.md
  13. requirements.in
  14. requirements_lock.txt
  15. WORKSPACE
README.md

Pigweed: minimal Bazel example

This repository contains a minimal example of a Bazel-based Pigweed project. It's an echo application for the STM32F429 Discovery Board.

Cloning

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.

Building

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

Flashing

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.

Communicating

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!