summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Abseil Team <absl-team@google.com>2018-04-09 10:01:14 -0700
committerGravatar Matt Calabrese <calabrese@x.team>2018-04-10 10:27:42 -0400
commit475d64f2de7403a01b1b36c487328ed41d29c20c (patch)
treec772600eaaacdcdde3576f3e4f74332dc231c419 /README.md
parent3f622d6c5990a7ae80eb8e52450c309a28bbec77 (diff)
- edb38790ce245c95715e5c50dfafb0db79d2cdc4 Add quickstart and build sections to readme. by Alex Strelnikov <strel@google.com>
- 508b3da428bc79cab730aa57109b352a58820573 Fix accidentally qualifying std int types with absl:: in ... by Alex Strelnikov <strel@google.com> GitOrigin-RevId: edb38790ce245c95715e5c50dfafb0db79d2cdc4 Change-Id: Idf72547f30c72fbb4153d5eae6b59b499ec42955
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 22 insertions, 6 deletions
diff --git a/README.md b/README.md
index 7150c8ed..8eed5751 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,11 @@ standard library.
## Table of Contents
- [About Abseil](#about)
+- [Quickstart](#quickstart)
+- [Building Abseil](#build)
- [Codemap](#codemap)
- [License](#license)
- [Links](#links)
-- [Build with cmake](#cmake)
<a name="about"></a>
## About Abseil
@@ -30,6 +31,26 @@ just found that many of these utilities serve a purpose within our code
base, and we now want to provide those resources to the C++ community as
a whole.
+<a name="quickstart"></a>
+## Quickstart
+
+If you want to just get started, make sure you at least run through the
+[Abseil Quickstart](https://abseil.io/docs/cpp/quickstart). The Quickstart
+contains information about setting up your development environment, downloading
+the Abseil code, running tests, and getting a simple binary working.
+
+<a name="build"></a>
+## Building Abseil
+
+[Bazel](http://bazel.build) is the official build system for Abseil,
+which is supported on most major platforms (Linux, Windows, MacOS, for example)
+and compilers. See the [quickstart](https://abseil.io/docs/cpp/quickstart) for
+more information on building Abseil using the Bazel build system.
+
+<a name="cmake"></a>
+If you require CMake support, please check the
+[CMake build instructions](CMake/README.md).
+
## Codemap
Abseil contains the following C++ library components:
@@ -85,8 +106,3 @@ For more information about Abseil:
* Peruse our
[Abseil Compatibility Guarantees](http://abseil.io/about/compatibility) to
understand both what we promise to you, and what we expect of you in return.
-
-<a name="cmake"></a>
-## Build with CMake
-
-Please check the [CMake build instructions](CMake/README.md)