aboutsummaryrefslogtreecommitdiffstats
path: root/docs/ProjectHome.md
diff options
context:
space:
mode:
authorBilly Donahue <BillyDonahue@users.noreply.github.com>2015-08-22 17:37:27 -0400
committerBilly Donahue <BillyDonahue@users.noreply.github.com>2015-08-22 17:37:27 -0400
commit3003e787a5f694e183cf3284a1ee85fe6a5db5b0 (patch)
treee6b4ce98d48a8e379733e10018576d999c7734da /docs/ProjectHome.md
parent642acbd61235dc68f606237193cf7e7c4a61af67 (diff)
parent613e23a4bf37470845405a6090ce5ac4d66f5b4a (diff)
downloadgoogletest-3003e787a5f694e183cf3284a1ee85fe6a5db5b0.tar.gz
googletest-3003e787a5f694e183cf3284a1ee85fe6a5db5b0.tar.bz2
googletest-3003e787a5f694e183cf3284a1ee85fe6a5db5b0.zip
Merge pull request #498 from BillyDonahue/wiki
Bring googlecode wiki markdown files into docs/ folder.
Diffstat (limited to 'docs/ProjectHome.md')
-rw-r--r--docs/ProjectHome.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/ProjectHome.md b/docs/ProjectHome.md
new file mode 100644
index 00000000..a0ce0aef
--- /dev/null
+++ b/docs/ProjectHome.md
@@ -0,0 +1,31 @@
+
+
+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.
+
+## 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).
+
+## Who Is Using Google Test? ##
+
+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](http://code.google.com/p/protobuf/) (Google's data interchange format)
+ * The [OpenCV](http://opencv.org/) computer vision library
+
+If you know of a project that's using Google Test and want it to be listed here, please let
+`googletestframework@googlegroups.com` know.
+
+## Google Test-related open source projects ##
+
+[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#.
+
+[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. \ No newline at end of file