Skip to content

Commit 27e5322

Browse files
Merge 75053eb into 6d74c06
2 parents 6d74c06 + 75053eb commit 27e5322

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,21 @@ The basic steps for configuring and building the library look like this:
2323

2424
```bash
2525
$ git clone https://github.com/google/benchmark.git
26-
# Benchmark requires GTest as a dependency. Add the source tree as a subdirectory.
26+
# Benchmark requires Google Test as a dependency. Add the source tree as a subdirectory.
2727
$ git clone https://github.com/google/googletest.git benchmark/googletest
2828
$ mkdir build && cd build
2929
$ cmake -G <generator> [options] ../benchmark
3030
# Assuming a makefile generator was used
3131
$ make
3232
```
3333

34-
Note that Google Benchmark requires GTest to build and run the tests. This
35-
dependency can be provided three ways:
34+
Note that Google Benchmark requires Google Test to build and run the tests. This
35+
dependency can be provided two ways:
3636

37-
* Checkout the GTest sources into `benchmark/googletest`.
37+
* Checkout the Google Test sources into `benchmark/googletest` as above.
3838
* Otherwise, if `-DBENCHMARK_DOWNLOAD_DEPENDENCIES=ON` is specified during
3939
configuration, the library will automatically download and build any required
4040
dependencies.
41-
* Otherwise, if nothing is done, CMake will use `find_package(GTest REQUIRED)`
42-
to resolve the required GTest dependency.
4341

4442
If you do not wish to build and run the tests, add `-DBENCHMARK_ENABLE_GTEST_TESTS=OFF`
4543
to `CMAKE_ARGS`.
@@ -61,6 +59,7 @@ Now, let's clone the repository and build it
6159
```
6260
git clone https://github.com/google/benchmark.git
6361
cd benchmark
62+
git clone https://github.com/google/googletest.git
6463
mkdir build
6564
cd build
6665
cmake .. -DCMAKE_BUILD_TYPE=RELEASE
@@ -88,6 +87,11 @@ to use, test, and provide feedback on the new features are encouraged to try
8887
this branch. However, this branch provides no stability guarantees and reserves
8988
the right to change and break the API at any time.
9089

90+
##Prerequisite knowledge
91+
92+
Before attempting to understand this framework one should ideally have some familiarity with the structure and format of the Google Test framework, upon which it is based. Documentation for Google Test, including a "Getting Started" (primer) guide, is available here:
93+
https://github.com/google/googletest/blob/master/googletest/docs/Documentation.md
94+
9195

9296
## Example usage
9397
### Basic usage

0 commit comments

Comments
 (0)