Update the readme, and (internally) fix some export processes to better keep it up-to-date going forward. PiperOrigin-RevId: 475272267 Change-Id: I3adfabc436c539b57a488aec4ff8760c6ed19447
diff --git a/README.md b/README.md index a12bc82..36e9b7c 100644 --- a/README.md +++ b/README.md
@@ -46,14 +46,13 @@ [Bazel](https://bazel.build) and [CMake](https://cmake.org/) are the official build systems for Abseil. - See the [quickstart](https://abseil.io/docs/cpp/quickstart) for more information on building Abseil using the Bazel build system. - If you require CMake support, please check the [CMake build instructions](CMake/README.md) and [CMake Quickstart](https://abseil.io/docs/cpp/quickstart-cmake). +<a name="support"></a> ## Support Abseil follows Google's [Foundational C++ Support @@ -63,11 +62,12 @@ for a list of currently supported versions compilers, platforms, and build tools. +<a name="codemap"></a> ## Codemap Abseil contains the following C++ library components: -* [`base`](absl/base/) Abseil Fundamentals +* [`base`](absl/base/) <br /> The `base` library contains initialization code and other code which all other Abseil code depends on. Code within `base` may not depend on any other code (other than the C++ standard library). @@ -83,12 +83,22 @@ * [`debugging`](absl/debugging/) <br /> The `debugging` library contains code useful for enabling leak checks, and stacktrace and symbolization utilities. +* [`flags`](absl/flags/) + <br /> The `flags` library contains code for handling command line flags for + libraries and binaries built with Abseil. * [`hash`](absl/hash/) <br /> The `hash` library contains the hashing framework and default hash functor implementations for hashable types in Abseil. +* [`iterator`](absl/iterator/) + <br /> The `iterator` library contains utilities for augmenting ranges in + range-based for loops. +* [`log`](absl/log/) + <br /> The `log` library contains `LOG` and `CHECK` macros and facilities + for writing logged messages out to disk, `stderr`, or user-extensible + destinations. * [`memory`](absl/memory/) - <br /> The `memory` library contains memory management facilities that - augment C++'s `<memory>` library. + <br /> The `memory` library contains memory management facilities that augment + C++'s `<memory>` library. * [`meta`](absl/meta/) <br /> The `meta` library contains compatible versions of type checks available within C++14 and C++17 versions of the C++ `<type_traits>` library. @@ -98,9 +108,12 @@ * [`profiling`](absl/profiling/) <br /> The `profiling` library contains utility code for profiling C++ entities. It is currently a private dependency of other Abseil libraries. +* [`random`](absl/random/) + <br /> The `random` library contains functions for generating psuedorandom + values. * [`status`](absl/status/) - <br /> The `status` contains abstractions for error handling, specifically - `absl::Status` and `absl::StatusOr<T>`. + <br /> The `status` library contains abstractions for error handling, + specifically `absl::Status` and `absl::StatusOr<T>`. * [`strings`](absl/strings/) <br /> The `strings` library contains a variety of strings routines and utilities, including a C++14-compatible version of the C++17 @@ -119,6 +132,7 @@ * [`utility`](absl/utility/) <br /> The `utility` library contains utility and helper code. +<a name="releases"></a> ## Releases Abseil recommends users "live-at-head" (update to the latest commit from the @@ -128,11 +142,13 @@ fixes for severe bugs. See our [release management](https://abseil.io/about/releases) document for more details. +<a name="license"></a> ## License The Abseil C++ library is licensed under the terms of the Apache license. See [LICENSE](LICENSE) for more information. +<a name="links"></a> ## Links For more information about Abseil: