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