summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbseil Team <absl-team@google.com>2021-03-09 17:08:31 -0800
committerDino Radaković <dinor@google.com>2021-03-10 08:49:32 -0800
commit861d535e2595894c7a214f05c1578d964a617643 (patch)
tree1a6a44da6a527cfd2f3dcb7a383e65f9e3ce1d77
parent763eaa430540926fa16060654427149802c97fba (diff)
downloadgoogletest-git-861d535e2595894c7a214f05c1578d964a617643.tar.gz
Googletest export
Update READMEs and issue template PiperOrigin-RevId: 361931644
-rw-r--r--.github/ISSUE_TEMPLATE/00-bug_report.md6
-rw-r--r--README.md29
-rw-r--r--googlemock/README.md8
3 files changed, 27 insertions, 16 deletions
diff --git a/.github/ISSUE_TEMPLATE/00-bug_report.md b/.github/ISSUE_TEMPLATE/00-bug_report.md
index 4d6a9235..0f7e8b53 100644
--- a/.github/ISSUE_TEMPLATE/00-bug_report.md
+++ b/.github/ISSUE_TEMPLATE/00-bug_report.md
@@ -19,9 +19,11 @@ problem, including your `BUILD`/`CMakeLists.txt` file and build commands. Links
to a GitHub branch or [godbolt.org](https://godbolt.org/) that demonstrate the
problem are also helpful.
-**What version of GoogleTest are you using?**
+**Does the bug persist in the most recent commit?**
-**What operating system and version are you using**
+We recommend using the latest commit in the master branch in your projects.
+
+**What operating system and version are you using?**
If you are using a Linux distribution please include the name and version of the
distribution as well.
diff --git a/README.md b/README.md
index 747d83e8..6dd931d9 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,18 @@
### Announcements
+#### Live at Head
+
+GoogleTest now follows the
+[Abseil Live at Head philosophy](https://abseil.io/about/philosophy#upgrade-support).
+We recommend using the latest commit in the `master` branch in your projects.
+
+#### Documentation Updates
+
+Our documentation is now live on GitHub Pages at
+https://google.github.io/googletest/. We recommend browsing the documentation on
+GitHub Pages rather than directly in the repository.
+
#### Release 1.10.x
[Release 1.10.x](https://github.com/google/googletest/releases/tag/release-1.10.0)
@@ -13,10 +25,9 @@ is now available.
#### Coming Soon
-* Post 1.10.x googletest will follow
- [Abseil Live at Head philosophy](https://abseil.io/about/philosophy)
-* We are also planning to take a dependency on
+* We are planning to take a dependency on
[Abseil](https://github.com/abseil/abseil-cpp).
+* More documentation improvements are planned.
## Welcome to **GoogleTest**, Google's C++ test framework!
@@ -26,14 +37,12 @@ release them together.
### Getting Started
-The information for **GoogleTest** is available in the
-[GoogleTest Primer](docs/primer.md) documentation.
-
-**GoogleMock** is an extension to GoogleTest for writing and using C++ mock
-classes. See the separate [GoogleMock documentation](googlemock/README.md).
+See the [GoogleTest User's Guide](https://google.github.io/googletest/) for
+documentation. We recommend starting with the
+[GoogleTest Primer](https://google.github.io/googletest/primer.html).
-More detailed documentation for googletest is in its interior
-[googletest/README.md](googletest/README.md) file.
+More information about building GoogleTest can be found at
+[googletest/README.md](googletest/README.md).
## Features
diff --git a/googlemock/README.md b/googlemock/README.md
index beeb7ea2..ead68832 100644
--- a/googlemock/README.md
+++ b/googlemock/README.md
@@ -30,10 +30,10 @@ gMock:
Details and examples can be found here:
-* [gMock for Dummies](../docs/gmock_for_dummies.md)
-* [Legacy gMock FAQ](../docs/gmock_faq.md)
-* [gMock Cookbook](../docs/gmock_cook_book.md)
-* [gMock Cheat Sheet](../docs/gmock_cheat_sheet.md)
+* [gMock for Dummies](https://google.github.io/googletest/gmock_for_dummies.html)
+* [Legacy gMock FAQ](https://google.github.io/googletest/gmock_faq.html)
+* [gMock Cookbook](https://google.github.io/googletest/gmock_cook_book.html)
+* [gMock Cheat Sheet](https://google.github.io/googletest/gmock_cheat_sheet.html)
Please note that code under scripts/generator/ is from the
[cppclean project](http://code.google.com/p/cppclean/) and under the Apache