summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGennadiy Civil <gennadiycivil@users.noreply.github.com>2019-06-12 11:15:00 -0400
committerGitHub <noreply@github.com>2019-06-12 11:15:00 -0400
commit89656ddbe62f9f0eeb6447868b31f2ec3b1052bb (patch)
tree7df5d11f5dfd288c7700ebfee5a79a309061b64b /README.md
parent076b7f7788833ca31206bc30e5a2cfbdb9628f29 (diff)
downloadgoogletest-git-89656ddbe62f9f0eeb6447868b31f2ec3b1052bb.tar.gz
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md115
1 files changed, 67 insertions, 48 deletions
diff --git a/README.md b/README.md
index 0bb313a1..2b64414d 100644
--- a/README.md
+++ b/README.md
@@ -1,78 +1,97 @@
+# Google Test
-# Google Test #
+#### OSS Builds Status:
[![Build Status](https://api.travis-ci.org/google/googletest.svg?branch=master)](https://travis-ci.org/google/googletest)
[![Build status](https://ci.appveyor.com/api/projects/status/4o38plt0xbo1ubc8/branch/master?svg=true)](https://ci.appveyor.com/project/GoogleTestAppVeyor/googletest/branch/master)
-**Future Plans**:
-* 1.8.x Release - [the 1.8.x](https://github.com/google/googletest/releases/tag/release-1.8.1) is the last release that works with pre-C++11 compilers. The 1.8.x will not accept any requests for any new features and any bugfix requests will only be accepted if proven "critical"
-* Post 1.8.x - work to improve/cleanup/pay technical debt. When this work is completed there will be a 1.9.x tagged release
-* Post 1.9.x googletest will follow [Abseil Live at Head philosophy](https://abseil.io/about/philosophy)
+### Future Plans
+#### 1.8.x Release:
-Welcome to **Google Test**, Google's C++ test framework!
+[the 1.8.x](https://github.com/google/googletest/releases/tag/release-1.8.1) is
+the last release that works with pre-C++11 compilers. The 1.8.x will not accept
+any requests for any new features and any bugfix requests will only be accepted
+if proven "critical"
-This repository is a merger of the formerly separate GoogleTest and
-GoogleMock projects. These were so closely related that it makes sense to
-maintain and release them together.
+#### Post 1.8.x:
-Please subscribe to the mailing list at googletestframework@googlegroups.com for questions, discussions, and development.
-There is also an IRC channel on [OFTC](https://webchat.oftc.net/) (irc.oftc.net) #gtest available.
+On-going work to improve/cleanup/pay technical debt. When this work is completed
+there will be a 1.9.x tagged release
-Getting started information for **Google Test** is available in the
+#### Post 1.9.x
+
+Post 1.9.x googletest will follow
+[Abseil Live at Head philosophy](https://abseil.io/about/philosophy)
+
+## Welcome to **Google Test**, Google's C++ test framework!
+
+This repository is a merger of the formerly separate GoogleTest and GoogleMock
+projects. These were so closely related that it makes sense to maintain and
+release them together.
+
+Please subscribe to the mailing list at googletestframework@googlegroups.com for
+questions, discussions, and development.
+
+### Getting started:
+
+The information for **Google Test** is available in the
[Google Test Primer](googletest/docs/primer.md) documentation.
**Google Mock** is an extension to Google Test for writing and using C++ mock
-classes. See the separate [Google Mock documentation](googlemock/README.md).
+classes. See the separate [Google Mock documentation](googlemock/README.md).
-More detailed documentation for googletest (including build instructions) are
-in its interior [googletest/README.md](googletest/README.md) file.
+More detailed documentation for googletest is in its interior
+[googletest/README.md](googletest/README.md) file.
-## Features ##
+## Features
- * An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
- * Test discovery.
- * A rich set of assertions.
- * User-defined assertions.
- * Death tests.
- * Fatal and non-fatal failures.
- * Value-parameterized tests.
- * Type-parameterized tests.
- * Various options for running the tests.
- * XML test report generation.
+* An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
+* Test discovery.
+* A rich set of assertions.
+* User-defined assertions.
+* Death tests.
+* Fatal and non-fatal failures.
+* Value-parameterized tests.
+* Type-parameterized tests.
+* Various options for running the tests.
+* XML test report generation.
-## Platforms ##
+## Platforms
Google test has been used on a variety of platforms:
- * Linux
- * Mac OS X
- * Windows
- * Cygwin
- * MinGW
- * Windows Mobile
- * Symbian
- * PlatformIO
+* Linux
+* Mac OS X
+* Windows
+* Cygwin
+* MinGW
+* Windows Mobile
+* Symbian
+* PlatformIO
-## Who Is Using Google Test? ##
+## Who Is Using Google Test?
-In addition to many internal projects at Google, Google Test is also used by
-the following notable projects:
+In addition to many internal projects at Google, Google Test is also used by the
+following notable projects:
- * The [Chromium projects](http://www.chromium.org/) (behind the Chrome
- browser and Chrome OS).
- * The [LLVM](http://llvm.org/) compiler.
- * [Protocol Buffers](https://github.com/google/protobuf), Google's data
+* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
+ and Chrome OS).
+* The [LLVM](http://llvm.org/) compiler.
+* [Protocol Buffers](https://github.com/google/protobuf), Google's data
interchange format.
- * The [OpenCV](http://opencv.org/) computer vision library.
- * [tiny-dnn](https://github.com/tiny-dnn/tiny-dnn): header only, dependency-free deep learning framework in C++11.
+* The [OpenCV](http://opencv.org/) computer vision library.
+* [tiny-dnn](https://github.com/tiny-dnn/tiny-dnn): header only,
+ dependency-free deep learning framework in C++11.
-## Related Open Source Projects ##
+## Related Open Source Projects
-[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based automated test-runner and Graphical User Interface with powerful features for Windows and Linux platforms.
+[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
+automated test-runner and Graphical User Interface with powerful features for
+Windows and Linux platforms.
-[Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that runs
-your test binary, allows you to track its progress via a progress bar, and
+[Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that
+runs your test binary, allows you to track its progress via a progress bar, and
displays a list of test failures. Clicking on one shows failure text. Google
Test UI is written in C#.