Skip to content

A
abseil-cpp
Commit 5937b7f9 by Andy Getzendanner Committed by Copybara-Service
Options

Update the readme, and (internally) fix some export processes to better keep it… 

Update the readme, and (internally) fix some export processes to better keep it up-to-date going forward.

PiperOrigin-RevId: 475272267
Change-Id: I3adfabc436c539b57a488aec4ff8760c6ed19447
parent 6b7b11a9
Showing with 23 additions and 7 deletions
README.md
...@@ -46,14 +46,13 @@ the Abseil code, running tests, and getting a simple binary working. ...@@ -46,14 +46,13 @@ the Abseil code, running tests, and getting a simple binary working.
[Bazel](https://bazel.build) and [CMake](https://cmake.org/) are the official [Bazel](https://bazel.build) and [CMake](https://cmake.org/) are the official
build systems for Abseil. build systems for Abseil.
See the [quickstart](https://abseil.io/docs/cpp/quickstart) for more information See the [quickstart](https://abseil.io/docs/cpp/quickstart) for more information
on building Abseil using the Bazel build system. on building Abseil using the Bazel build system.
If you require CMake support, please check the [CMake build If you require CMake support, please check the [CMake build
instructions](CMake/README.md) and [CMake instructions](CMake/README.md) and [CMake
Quickstart](https://abseil.io/docs/cpp/quickstart-cmake). Quickstart](https://abseil.io/docs/cpp/quickstart-cmake).
<a name="support"></a>
## Support ## Support
Abseil follows Google's [Foundational C++ Support Abseil follows Google's [Foundational C++ Support
...@@ -63,11 +62,12 @@ table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-su ...@@ -63,11 +62,12 @@ table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-su
for a list of currently supported versions compilers, platforms, and build for a list of currently supported versions compilers, platforms, and build
tools. tools.
<a name="codemap"></a>
## Codemap ## Codemap
Abseil contains the following C++ library components: 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 <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 all other Abseil code depends on. Code within `base` may not depend on any
other code (other than the C++ standard library). other code (other than the C++ standard library).
...@@ -83,12 +83,22 @@ Abseil contains the following C++ library components: ...@@ -83,12 +83,22 @@ Abseil contains the following C++ library components:
* [`debugging`](absl/debugging/) * [`debugging`](absl/debugging/)
<br /> The `debugging` library contains code useful for enabling leak <br /> The `debugging` library contains code useful for enabling leak
checks, and stacktrace and symbolization utilities. 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/) * [`hash`](absl/hash/)
<br /> The `hash` library contains the hashing framework and default hash <br /> The `hash` library contains the hashing framework and default hash
functor implementations for hashable types in Abseil. 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/) * [`memory`](absl/memory/)
<br /> The `memory` library contains memory management facilities that <br /> The `memory` library contains memory management facilities that augment
augment C++'s `<memory>` library. C++'s `<memory>` library.
* [`meta`](absl/meta/) * [`meta`](absl/meta/)
<br /> The `meta` library contains compatible versions of type checks <br /> The `meta` library contains compatible versions of type checks
available within C++14 and C++17 versions of the C++ `<type_traits>` library. available within C++14 and C++17 versions of the C++ `<type_traits>` library.
...@@ -98,9 +108,12 @@ Abseil contains the following C++ library components: ...@@ -98,9 +108,12 @@ Abseil contains the following C++ library components:
* [`profiling`](absl/profiling/) * [`profiling`](absl/profiling/)
<br /> The `profiling` library contains utility code for profiling C++ <br /> The `profiling` library contains utility code for profiling C++
entities. It is currently a private dependency of other Abseil libraries. 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/) * [`status`](absl/status/)
<br /> The `status` contains abstractions for error handling, specifically <br /> The `status` library contains abstractions for error handling,
`absl::Status` and `absl::StatusOr<T>`. specifically `absl::Status` and `absl::StatusOr<T>`.
* [`strings`](absl/strings/) * [`strings`](absl/strings/)
<br /> The `strings` library contains a variety of strings routines and <br /> The `strings` library contains a variety of strings routines and
utilities, including a C++14-compatible version of the C++17 utilities, including a C++14-compatible version of the C++17
...@@ -119,6 +132,7 @@ Abseil contains the following C++ library components: ...@@ -119,6 +132,7 @@ Abseil contains the following C++ library components:
* [`utility`](absl/utility/) * [`utility`](absl/utility/)
<br /> The `utility` library contains utility and helper code. <br /> The `utility` library contains utility and helper code.
<a name="releases"></a>
## Releases ## Releases
Abseil recommends users "live-at-head" (update to the latest commit from the Abseil recommends users "live-at-head" (update to the latest commit from the
...@@ -128,11 +142,13 @@ Releases](https://github.com/abseil/abseil-cpp/releases) to which we backport ...@@ -128,11 +142,13 @@ Releases](https://github.com/abseil/abseil-cpp/releases) to which we backport
fixes for severe bugs. See our [release fixes for severe bugs. See our [release
management](https://abseil.io/about/releases) document for more details. management](https://abseil.io/about/releases) document for more details.
<a name="license"></a>
## License ## License
The Abseil C++ library is licensed under the terms of the Apache The Abseil C++ library is licensed under the terms of the Apache
license. See [LICENSE](LICENSE) for more information. license. See [LICENSE](LICENSE) for more information.
<a name="links"></a>
## Links ## Links
For more information about Abseil: For more information about Abseil:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment