xref: /aosp_15_r20/external/truth/README.md (revision b3996a89512f34bffd8f9a69f0bc726f1b19016a)
1*b3996a89SAndroid Build Coastguard Worker[![Main Site][gh-pages-shield]][gh-pages-link]
2*b3996a89SAndroid Build Coastguard Worker[![Build Status][ci-shield]][ci-link]
3*b3996a89SAndroid Build Coastguard Worker[![Maven Release][maven-shield]][maven-link]
4*b3996a89SAndroid Build Coastguard Worker[![Stackoverflow][stackoverflow-shield]][stackoverflow-link]
5*b3996a89SAndroid Build Coastguard Worker
6*b3996a89SAndroid Build Coastguard Worker## What is Truth?
7*b3996a89SAndroid Build Coastguard Worker
8*b3996a89SAndroid Build Coastguard WorkerTruth makes your [test assertions] and [failure messages] more readable.
9*b3996a89SAndroid Build Coastguard Worker[Similar][comparison] to [AssertJ], it [natively supports][known_types] many JDK
10*b3996a89SAndroid Build Coastguard Workerand [Guava] types, and it is [extensible][extension] to others.
11*b3996a89SAndroid Build Coastguard Worker
12*b3996a89SAndroid Build Coastguard WorkerTruth is owned and maintained by the [Guava] team. It is used in the majority
13*b3996a89SAndroid Build Coastguard Workerof the tests in Google’s own codebase.
14*b3996a89SAndroid Build Coastguard Worker
15*b3996a89SAndroid Build Coastguard WorkerRead more at [the main website](https://truth.dev).
16*b3996a89SAndroid Build Coastguard Worker
17*b3996a89SAndroid Build Coastguard Worker<!-- references -->
18*b3996a89SAndroid Build Coastguard Worker
19*b3996a89SAndroid Build Coastguard Worker[test assertions]: https://truth.dev/benefits#readable-assertions
20*b3996a89SAndroid Build Coastguard Worker[failure messages]: https://truth.dev/benefits#readable-messages
21*b3996a89SAndroid Build Coastguard Worker[comparison]: https://truth.dev/comparison
22*b3996a89SAndroid Build Coastguard Worker[AssertJ]: http://joel-costigliola.github.io/assertj/
23*b3996a89SAndroid Build Coastguard Worker[known_types]: https://truth.dev/known_types
24*b3996a89SAndroid Build Coastguard Worker[extension]: https://truth.dev/extension
25*b3996a89SAndroid Build Coastguard Worker[Guava]: https://github.com/google/guava
26*b3996a89SAndroid Build Coastguard Worker[gh-pages-shield]: https://img.shields.io/badge/main%20site-truth.dev-ff55ff.png?style=flat
27*b3996a89SAndroid Build Coastguard Worker[gh-pages-link]: https://truth.dev/
28*b3996a89SAndroid Build Coastguard Worker[ci-shield]: https://github.com/google/truth/workflows/CI/badge.svg?branch=master
29*b3996a89SAndroid Build Coastguard Worker[ci-link]: https://github.com/google/truth/actions
30*b3996a89SAndroid Build Coastguard Worker[maven-shield]: https://img.shields.io/maven-central/v/com.google.truth/truth.png
31*b3996a89SAndroid Build Coastguard Worker[maven-link]: https://search.maven.org/artifact/com.google.truth/truth
32*b3996a89SAndroid Build Coastguard Worker[stackoverflow-shield]: https://img.shields.io/badge/stackoverflow-googletruth-5555ff.png?style=flat
33*b3996a89SAndroid Build Coastguard Worker[stackoverflow-link]: https://stackoverflow.com/questions/tagged/google-truth
34