summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryagneshprajapati <131433627+yagneshprajapati@users.noreply.github.com>2023-05-07 15:22:54 +0530
committerGitHub <noreply@github.com>2023-05-07 15:22:54 +0530
commita7fa9b37082993107a98181e631cafcdbe484f22 (patch)
treefa2cb5f08f06e0abda15b6564dce5b45063074de
parentbc860af08783b8113005ca7697da5f5d49a8056f (diff)
downloadgoogletest-git-a7fa9b37082993107a98181e631cafcdbe484f22.tar.gz
Update README.md
-rw-r--r--README.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/README.md b/README.md
index 23eb5026..1284b8d3 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,7 @@ 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.
-### Getting Started
+### | Getting Started |
See the [GoogleTest User's Guide](https://google.github.io/googletest/) for
documentation. We recommend starting with the
@@ -50,18 +50,19 @@ documentation. We recommend starting with the
More information about building GoogleTest can be found at
[googletest/README.md](googletest/README.md).
-## 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.
+| Feature | Description |
+| --- | --- |
+| xUnit test framework | Googletest is based on the xUnit testing framework, a popular architecture for unit testing |
+| Test discovery | Googletest automatically discovers and runs your tests, eliminating the need to manually register your tests |
+| Rich set of assertions | Googletest provides a variety of assertions, such as equality, inequality, exceptions, and more, making it easy to test your code |
+| User-defined assertions | You can define your own assertions with Googletest, making it simple to write tests that are specific to your code |
+| Death tests | Googletest supports death tests, which verify that your code exits in a certain way, making it useful for testing error-handling code |
+| Fatal and non-fatal failures | You can specify whether a test failure should be treated as fatal or non-fatal with Googletest, allowing tests to continue running even if a failure occurs |
+| Value-parameterized tests | Googletest supports value-parameterized tests, which run multiple times with different input values, making it useful for testing functions that take different inputs |
+| Type-parameterized tests | Googletest also supports type-parameterized tests, which run with different data types, making it useful for testing functions that work with different data types |
+| Various options for running tests | Googletest provides many options for running tests, including running individual tests, running tests in a specific order, and running tests in parallel |
+| XML test report generation | Googletest can generate XML test reports, which can be used by tools like Jenkins to track the results of your tests |
+
## Supported Platforms