summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBilly Donahue <billydonahue@google.com>2015-08-25 22:23:36 (GMT)
committerBilly Donahue <billydonahue@google.com>2015-08-25 22:23:36 (GMT)
commit5b3ef3bd6cb94e1043f9d4dcbfbd537933b42d64 (patch)
tree0f94fc25b6237a12ab3e3260206ac4be2cd1c3e8 /README.md
parent7563fe553e7e28fcfdc1be264ee5f8758686868b (diff)
downloadgoogletest-5b3ef3bd6cb94e1043f9d4dcbfbd537933b42d64.zip
googletest-5b3ef3bd6cb94e1043f9d4dcbfbd537933b42d64.tar.gz
googletest-5b3ef3bd6cb94e1043f9d4dcbfbd537933b42d64.tar.bz2
unified project home
Diffstat (limited to 'README.md')
-rw-r--r--README.md120
1 files changed, 62 insertions, 58 deletions
diff --git a/README.md b/README.md
index 01edbb0..137017b 100644
--- a/README.md
+++ b/README.md
@@ -1,87 +1,91 @@
-Welcome to **Google C++ Mocking Framework**!
-Inspired by [jMock](http://www.jmock.org/), [EasyMock](http://www.easymock.org/), and [Hamcrest](http://code.google.com/p/hamcrest/), and
-designed with C++'s specifics in mind, Google C++ Mocking Framework
-(or **Google Mock** for short) is a library for writing and using C++
-mock classes. Google Mock:
+Welcome to **Google C++ Test Framework**!
- * lets you create mock classes trivially using simple macros,
- * supports a rich set of matchers and actions,
- * handles unordered, partially ordered, or completely ordered expectations,
- * is extensible by users, and
- * works on Linux, Mac OS X, Windows, Windows Mobile, minGW, and Symbian.
+This GitHub repository is a merger of the former <googletest> and <googlemock> products,
+which are so closely related that it makes sense to maintain and release them together.
-We hope you find it useful!
-
-## Who are using Google Mock? ##
+## GoogleTest ##
-We have enjoyed using Google Mock in many projects at Google. Outside of Google, the most notable client is probably the [Chromium projects](http://www.chromium.org/) (behind the Chrome browser and Chrome OS). If you know of a project that's using Google Mock and want it to be listed here, please let
-`googlemock@googlegroups.com` know.
+Based on the xUnit architecture. Supports automatic test discovery, a rich
+set of assertions, user-defined assertions, death tests, fatal and
+non-fatal failures, value- and type-parameterized tests, various
+options for running the tests, and XML test report generation.
+## Platforms ##
-## System Requirements ##
+Google test has been used on a variety of platforms:
-Google Mock is not a testing framework itself. Instead, it needs a
-testing framework for writing tests. Google Mock works seamlessly
-with [Google Test](http://code.google.com/p/googletest/). It comes
-with a copy of Google Test bundled. Starting with version 1.1.0,
-you can also use it with [any C++ testing framework of your choice](ForDummies#Using_Google_Mock_with_Any_Testing_Framework.md).
+ * Linux
+ * Mac OS X
+ * Windows
+ * Cygwin
+ * MinGW
+ * Windows Mobile
+ * Symbian
-Google Mock has been tested with **gcc 4.0+** and **Microsoft Visual C++ 8.0 SP1**. Users
-reported that it also works with **gcc 3.4**, **Microsoft Visual C++ 7.1**, and **Cygwin**, although we haven't tested it there ourselves.
+## Who Is Using Google Test? ##
-## Getting Started ##
+In addition to many internal projects at Google, Google Test is also used by
+the following notable projects:
-If you are new to the project, we suggest to read the user
-documentation in the following order:
+ * The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser and Chrome OS)
+ * The [LLVM](http://llvm.org/) compiler
+ * [Protocol Buffers](http://code.google.com/p/protobuf/) (Google's data interchange format)
+ * The [OpenCV](http://opencv.org/) computer vision library
- * Learn the [basics](http://code.google.com/p/googletest/wiki/Primer) of Google Test, if you choose to use Google Mock with it (recommended).
- * Read [Google Mock for Dummies](ForDummies.md).
- * Read the instructions on how to [build Google Mock](http://code.google.com/p/googlemock/source/browse/trunk/README).
+## Google Test-related open source projects ##
-You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation.
+[Google Test UI](http://code.google.com/p/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#.
-Once you understand the basics, check out the rest of the docs:
+[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
+listener for Google Test that implements the
+[TAP protocol](http://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
+result output. If your test runner understands TAP, you may find it useful.
- * CheatSheet - all the commonly used stuff at a glance.
- * CookBook - recipes for getting things done, including advanced techniques.
+## About Google Mock ##
-If you need help, please check the KnownIssues and FrequentlyAskedQuestions before
-posting a question on the [googlemock](http://groups.google.com/group/googlemock)
-discussion group.
+**Google Mock** is an extension to Google Test for writing and using C++ mock classes.
+It is inspired by [jMock](http://www.jmock.org/), [EasyMock](http://www.easymock.org/),
+and [Hamcrest](http://code.google.com/p/hamcrest/), and designed with C++'s specifics in mind.
-We'd love to have your help! Please
-read the DevGuide if you are willing to contribute to the development.
+Google mock:
-Happy mocking!
+ * lets you create mock classes trivially using simple macros.
+ * supports a rich set of matchers and actions.
+ * handles unordered, partially ordered, or completely ordered expectations.
+ * is extensible by users.
+We hope you find it useful!
-Google's framework for writing C++ tests on a variety of platforms
-(Linux, Mac OS X, Windows, Cygwin, Windows CE, and Symbian). Based on
-the xUnit architecture. Supports automatic test discovery, a rich set
-of assertions, user-defined assertions, death tests, fatal and
-non-fatal failures, value- and type-parameterized tests, various
-options for running the tests, and XML test report generation.
+## Using Google Mock Without Google Test ##
+Google Mock is not a testing framework itself. Instead, it needs a
+testing framework for writing tests. Google Mock works seamlessly
+with [Google Test](http://code.google.com/p/googletest/), butj
+you can also use it with [any C++ testing framework](googlemock/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework).
## Getting Started ##
-After downloading Google Test, unpack it, read the README file and the documentation wiki pages (listed on the right side of this front page).
+If you are new to the project, we suggest that you read the user
+documentation in the following order:
-## Who Is Using Google Test? ##
+ * Learn the [basics](http://code.google.com/p/googletest/wiki/Primer) of Google Test, if you choose to use Google Mock with it (recommended).
+ * Read [Google Mock for Dummies](ForDummies.md).
+ * Read the instructions on how to [build Google Mock](http://code.google.com/p/googlemock/source/browse/trunk/README).
-In addition to many internal projects at Google, Google Test is also used by
-the following notable projects:
+You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation.
- * The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser and Chrome OS)
- * The [LLVM](http://llvm.org/) compiler
- * [Protocol Buffers](http://code.google.com/p/protobuf/) (Google's data interchange format)
- * The [OpenCV](http://opencv.org/) computer vision library
+Once you understand the basics, check out the rest of the docs:
-If you know of a project that's using Google Test and want it to be listed here, please let
-`googletestframework@googlegroups.com` know.
+ * [CheatSheet](googlemock/docs/CheatSheet.md) - all the commonly used stuff at a glance.
+ * [CookBook](googlemock/docs/CookBook.md) - recipes for getting things done, including advanced techniques.
-## Google Test-related open source projects ##
+If you need help, please check the [KnownIssues](googlemock/docs/KnownIssues.md) and
+[FrequentlyAskedQuestions](googlemock/docs/frequentlyaskedquestions.md) before
+posting a question on the [googlemock discussion group](http://groups.google.com/group/googlemock).
-[Google Test UI](http://code.google.com/p/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#.
+We'd love to have your help! Please read the Developer Guides if you are willing to contribute to the development.
-[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event listener for Google Test that implements the [TAP protocol](http://en.wikipedia.org/wiki/Test_Anything_Protocol) for test result output. If your test runner understands TAP, you may find it useful.
+Happy mocking!