From 9b42d0bfe8d09ac36552518bb024877bed152c3e Mon Sep 17 00:00:00 2001 From: Nilay Vaish Date: Wed, 6 Apr 2022 10:29:46 -0700 Subject: [PATCH] Internal changes PiperOrigin-RevId: 439876720 Change-Id: Icd5a25d3be6425e9944f60cd903d8bb81683ccf5 --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c848b4838..46fc49c1f 100644 --- a/README.md +++ b/README.md @@ -17,28 +17,29 @@ platform support for TCMalloc. All users of TCMalloc should consult the following documentation resources: -* The [TCMalloc Quickstart](docs/quickstart.md) covers downloading, installing, - building, and testing TCMalloc, including incorporating within your codebase. -* The [TCMalloc Overview](docs/overview.md) covers the basic architecture of - TCMalloc, and how that may affect configuration choices. -* The [TCMalloc Reference](docs/reference.md) covers the C and C++ TCMalloc API - endpoints. +* The [TCMalloc Quickstart](docs/quickstart.md) covers downloading, + installing, building, and testing TCMalloc, including incorporating within + your codebase. +* The [TCMalloc Overview](docs/overview.md) covers the basic architecture of + TCMalloc, and how that may affect configuration choices. +* The [TCMalloc Reference](docs/reference.md) covers the C and C++ TCMalloc + API endpoints. More advanced usages of TCMalloc may find the following documentation useful: -* The [TCMalloc Tuning Guide](docs/tuning.md) covers the configuration choices - in more depth, and also illustrates other ways to customize TCMalloc. This - also covers important operating system-level properties for improving TCMalloc - performance. -* The [TCMalloc Design Doc](docs/design.md) covers how TCMalloc works - underneath the hood, and why certain design choices were made. Most developers - will not need this level of implementation detail. -* The [TCMalloc Compatibility Guide](docs/compatibility.md) which documents our - expectations for how our APIs are used. +* The [TCMalloc Tuning Guide](docs/tuning.md) covers the configuration + choices in more depth, and also illustrates other ways to customize + TCMalloc. This also covers important operating system-level properties for + improving TCMalloc performance. +* The [TCMalloc Design Doc](docs/design.md) covers how TCMalloc works + underneath the hood, and why certain design choices were made. Most + developers will not need this level of implementation detail. +* The [TCMalloc Compatibility Guide](docs/compatibility.md) which documents + our expectations for how our APIs are used. ## License -The TCMalloc library is licensed under the terms of the Apache -license. See LICENSE for more information. +The TCMalloc library is licensed under the terms of the Apache license. See +LICENSE for more information. Disclaimer: This is not an officially supported Google product.