Google Git
Sign in
opensecura / 3p / google / pigweed / 42225322885b0ed153b9e868261eb72e95684235
commit42225322885b0ed153b9e868261eb72e95684235[log] [tgz]
authorArmando Montanez <amontanez@google.com>Thu Jan 02 13:11:41 2020 -0800
committerCQ Bot Account <commit-bot@chromium.org>Fri Jan 03 00:44:56 2020 +0000
tree7e00fbd0bcd3cf21aeead44db9bf87efc783b219
parent213060fd225cd39be798a33ae5765e9dae7900c9 [diff]
Import README.md into pigweed docs

Replaces the contents of the Pigweed documentation landing page with
the README.md inlined and converted to rst.

Change-Id: I6457aaede5ca4c0585af4a00c388278fb14223f5
5 files changed
tree: 7e00fbd0bcd3cf21aeead44db9bf87efc783b219
  1. docs/
  2. env_setup/
  3. pw_bloat/
  4. pw_build/
  5. pw_cli/
  6. pw_cpu_exception/
  7. pw_cpu_exception_armv7m/
  8. pw_docgen/
  9. pw_dumb_io/
  10. pw_dumb_io_baremetal_stm32f429/
  11. pw_dumb_io_stdio/
  12. pw_module/
  13. pw_preprocessor/
  14. pw_presubmit/
  15. pw_protobuf/
  16. pw_protobuf_compiler/
  17. pw_span/
  18. pw_status/
  19. pw_string/
  20. pw_target_runner/
  21. pw_toolchain/
  22. pw_unit_test/
  23. pw_varint/
  24. targets/
  25. .clang-format
  26. .gitignore
  27. .gn
  28. .pylintrc
  29. AUTHORS
  30. BUILD
  31. BUILD.gn
  32. BUILDCONFIG.gn
  33. CONTRIBUTING.md
  34. LICENSE
  35. modules.gni
  36. pw_vars_default.gni
  37. README.md
  38. WORKSPACE
README.md

Pigweed Embedded Oriented Software Libraries

Pigweed is a collection of embedded-focused libraries, which we call “modules”. These modules are designed for small-footprint MMU-less microcontrollers like the ST Micro STM32L452 or the Nordic NRF82832. The modules are designed to facilitate easy integration into existing codebases.

Pigweed is in the early stages of development.

Getting Started

$ git clone sso://pigweed.googlesource.com/pigweed/pigweed ~/pigweed
$ cd ~/pigweed
$ env_setup/cipd/cipd.py auth-login  # Once per machine.
$ . env_setup/setup.sh

If you‘re using Homebrew and you get an error saying module 'http.client' has no attribute 'HTTPSConnection' then your Homebrew Python was not set up to support SSL. Ensure it’s installed with brew install openssl and then run brew uninstall python && brew install python. After that things should work.

The environment setup script will pull down the versions of tools necessary to build Pigweed and add them to your environment. You can then build with either GN or Bazel. You can also confirm you're getting the right versions of tools—they should be installed under env_setup/.

$ which gn
~/pigweed/.cipd/pigweed.ensure/gn
$ gn gen out/host
$ ninja -C out/host

$ which bazel
~/pigweed/.cipd/pigweed.ensure/bazel
$ bazel test //...

And do the following to test on the STM32F429 Discovery board. (The bazel build does not yet support building for hardware.)

$ gn gen --args='pw_target_config = "//targets/stm32f429i-disc1/target_config.gni"' out/disco
$ ninja -C out/disco
$ pw test --root out/disco/ --runner stm32f429i_disc1_unit_test_runner -- --port /dev/ttyACM0

If any of this doesn't work please file a bug.