Google Git
Sign in
opensecura / 3p / google / pigweed / ee3e02f6cb0ce760135deae93ea2bab19ba8df36
commitee3e02f6cb0ce760135deae93ea2bab19ba8df36[log] [tgz]
authorWyatt Hepler <hepler@google.com>Thu Dec 05 10:52:31 2019 -0800
committerWyatt Hepler <hepler@google.com>Mon Dec 09 17:13:47 2019 -0800
tree35856c4ccdf7825a5dac7ee56baba27089b34920
parentd2e4903a42a6379fbe08f364490046a8f3bdf3d1 [diff]
Expand docs for a few modules

- Add missing README.md for a few modules.
- Start or expand docs.rst.

Change-Id: Ic13c5f71f02259205ba990c93e0403d43f7b44b1
16 files changed
tree: 35856c4ccdf7825a5dac7ee56baba27089b34920
  1. docs/
  2. env_setup/
  3. pw_bloat/
  4. pw_build/
  5. pw_cli/
  6. pw_docgen/
  7. pw_dumb_io/
  8. pw_dumb_io_baremetal_stm32f429/
  9. pw_dumb_io_stdio/
  10. pw_module/
  11. pw_preprocessor/
  12. pw_presubmit/
  13. pw_span/
  14. pw_status/
  15. pw_string/
  16. pw_test_server/
  17. pw_toolchain/
  18. pw_unit_test/
  19. pw_varint/
  20. targets/
  21. .clang-format
  22. .gitignore
  23. .gn
  24. .pylintrc
  25. AUTHORS
  26. BUILD
  27. BUILD.gn
  28. BUILDCONFIG.gn
  29. CONTRIBUTING.md
  30. LICENSE
  31. modules.gni
  32. pw_vars_default.gni
  33. README.md
  34. 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/env_setup/cipd/tools/gn
$ gn gen out/host
$ ninja -C out/host

$ which bazel
~/pigweed/env_setup/cipd/tools/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.