xref: /freebsd/contrib/googletest/docs/index.md (revision 535af610a4fdace6d50960c0ad9be0597eea7a1b)
1# GoogleTest User's Guide
2
3## Welcome to GoogleTest!
4
5GoogleTest is Google's C++ testing and mocking framework. This user's guide has
6the following contents:
7
8*   [GoogleTest Primer](primer.md) - Teaches you how to write simple tests using
9    GoogleTest. Read this first if you are new to GoogleTest.
10*   [GoogleTest Advanced](advanced.md) - Read this when you've finished the
11    Primer and want to utilize GoogleTest to its full potential.
12*   [GoogleTest Samples](samples.md) - Describes some GoogleTest samples.
13*   [GoogleTest FAQ](faq.md) - Have a question? Want some tips? Check here
14    first.
15*   [Mocking for Dummies](gmock_for_dummies.md) - Teaches you how to create mock
16    objects and use them in tests.
17*   [Mocking Cookbook](gmock_cook_book.md) - Includes tips and approaches to
18    common mocking use cases.
19*   [Mocking Cheat Sheet](gmock_cheat_sheet.md) - A handy reference for
20    matchers, actions, invariants, and more.
21*   [Mocking FAQ](gmock_faq.md) - Contains answers to some mocking-specific
22    questions.
23