diff options
| author | Keir Mierle <keir@google.com> | 2020-03-19 12:34:45 -0700 |
|---|---|---|
| committer | CQ Bot Account <commit-bot@chromium.org> | 2020-03-19 20:25:49 +0000 |
| commit | 064da0b8e1bb40f9a49c409e23c0d3448f1e493a (patch) | |
| tree | c4afc251c90b8a8d5769ac92761a30061d0ae6c0 /README.md | |
| parent | a1065b928287c4df70ee8299c1e94d2a5c1fea80 (diff) | |
| download | pigweed-064da0b8e1bb40f9a49c409e23c0d3448f1e493a.tar.gz | |
docs: Update macOS guide; docs build mention in README
- Remove discussion of Python SSL issues on Mac; awhile ago code to
detect this issue and print a useful message was added.
- Mention that the docs need to be built on the front page; otherwise
the experience is a bit confusing.
Change-Id: I0c881b78e6f4e921f7688db7e647bc58f2e8b6c7
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -22,6 +22,10 @@ selection that happen to produce visual output. For more information about the different Pigweed module offerings, refer to "Module Guides" section in the full documentation. +Note: For now the full documentation is not available online; you must build +it. Building the docs is easy; see the [getting started +guide](docs/getting_started.md) for how. + ## `pw_watch` - Build, flash, run, & test on save In the web development space, file system watchers are prevalent. These watchers |