Update README.md

This commit is contained in:
Gennadiy Civil 2019-06-12 11:15:00 -04:00 committed by GitHub
parent 076b7f7788
commit 89656ddbe6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

113
README.md
View File

@ -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://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) [![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**: ### 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)
#### 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 #### Post 1.8.x:
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. On-going work to improve/cleanup/pay technical debt. When this work is completed
There is also an IRC channel on [OFTC](https://webchat.oftc.net/) (irc.oftc.net) #gtest available. 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 Test Primer](googletest/docs/primer.md) documentation.
**Google Mock** is an extension to Google Test for writing and using C++ mock **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 More detailed documentation for googletest is in its interior
in its interior [googletest/README.md](googletest/README.md) file. [googletest/README.md](googletest/README.md) file.
## Features ## ## Features
* An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework. * An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
* Test discovery. * Test discovery.
* A rich set of assertions. * A rich set of assertions.
* User-defined assertions. * User-defined assertions.
* Death tests. * Death tests.
* Fatal and non-fatal failures. * Fatal and non-fatal failures.
* Value-parameterized tests. * Value-parameterized tests.
* Type-parameterized tests. * Type-parameterized tests.
* Various options for running the tests. * Various options for running the tests.
* XML test report generation. * XML test report generation.
## Platforms ## ## Platforms
Google test has been used on a variety of platforms: Google test has been used on a variety of platforms:
* Linux * Linux
* Mac OS X * Mac OS X
* Windows * Windows
* Cygwin * Cygwin
* MinGW * MinGW
* Windows Mobile * Windows Mobile
* Symbian * Symbian
* PlatformIO * 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 In addition to many internal projects at Google, Google Test is also used by the
the following notable projects: following notable projects:
* The [Chromium projects](http://www.chromium.org/) (behind the Chrome * The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
browser and Chrome OS). and Chrome OS).
* The [LLVM](http://llvm.org/) compiler. * The [LLVM](http://llvm.org/) compiler.
* [Protocol Buffers](https://github.com/google/protobuf), Google's data * [Protocol Buffers](https://github.com/google/protobuf), Google's data
interchange format. interchange format.
* The [OpenCV](http://opencv.org/) computer vision library. * 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. * [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 [Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that
your test binary, allows you to track its progress via a progress bar, and 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 displays a list of test failures. Clicking on one shows failure text. Google
Test UI is written in C#. Test UI is written in C#.