diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 6 insertions, 14 deletions
@@ -13,14 +13,16 @@ value developer feedback along the way. # Quick links - [Getting started guide](docs/getting_started.md) - - [Source code](https://pigweed.googlesource.com/pigweed/pigweed/+/refs/heads/master) + - [Documentation](https://pigweed.dev) + - [Source code](https://cs.opensource.google/pigweed/pigweed) - [Code reviews](https://pigweed-review.googlesource.com/) - - [Issue tracker](https://bugs.chromium.org/p/pigweed/issues/list) + - [Issue tracker](https://bugs.pigweed.dev/) - [Mailing list](https://groups.google.com/forum/#!forum/pigweed) - [Chat room (Discord)](https://discord.gg/M9NSeTA) - [Open Source blog post](https://opensource.googleblog.com/2020/03/pigweed-collection-of-embedded-libraries.html) -Get the code: `git clone https://pigweed.googlesource.com/pigweed/pigweed` +Get the code: `git clone https://pigweed.googlesource.com/pigweed/pigweed` (or +[fork us on GitHub](https://github.com/google/pigweed)). # Getting Started @@ -34,10 +36,6 @@ 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 @@ -122,7 +120,7 @@ on-device. See the "Module Guides" in the documentation for the complete list and documentation for each, but is a selection of some others: - - `pw_cpu_exception_armv7m`: Robust low level hardware fault handler for ARM + - `pw_cpu_exception_cortex_m`: Robust low level hardware fault handler for ARM Cortex-M; the handler even has unit tests written in assembly to verify nested-hardware-fault handling! @@ -130,12 +128,6 @@ documentation for each, but is a selection of some others: provides selected C++17 standard library components that are compatible with C++11 and C++14. - - `pw_minimal_cpp_stdlib`: An entirely incomplete implementation of the C++17 - standard library, that provides some of the primitives needed by Pigweed - itself. Useful for projects that want to use Pigweed, but don’t enable the - typical standard C++ libraries like GNU’s libstdc++ or LLVM’s libc++. Don’t - use this module unless you know what you are doing. - - `pw_tokenizer`: Replace string literals from log statements with 32-bit tokens, to reduce flash use, reduce logging bandwidth, and save formatting cycles from log statements at runtime. |