README.md

   1 ![catch logo](catch-logo-small.png)
   2
   3 [![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/philsquared/catch/releases)
   4 [![Build Status](https://travis-ci.org/philsquared/Catch.svg?branch=master)](https://travis-ci.org/philsquared/Catch)
   5 [![Build status](https://ci.appveyor.com/api/projects/status/hrtk60hv6tw6fght/branch/master?svg=true)](https://ci.appveyor.com/project/philsquared/catch/branch/master)
   6 [![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/jG7wnHX9VAcxpSHy)
   7
   8 <a href="https://github.com/philsquared/Catch/releases/download/v1.12.2/catch.hpp">The latest, single header, version can be downloaded directly using this link</a>
   9
  10 ## What's the Catch?
  11
  12 Catch stands for C++ Automated Test Cases in Headers and is a multi-paradigm automated test framework for C++ and Objective-C (and, maybe, C). It is implemented entirely in a set of header files, but is packaged up as a single header for extra convenience.
  13
  14 ## How to use it
  15 This documentation comprises these three parts:
  16
  17 * [Why do we need yet another C++ Test Framework?](docs/why-catch.md)
  18 * [Tutorial](docs/tutorial.md) - getting started
  19 * [Reference section](docs/Readme.md) - all the details
  20
  21 ## More
  22 * Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/philsquared/Catch/issues)
  23 * For discussion or questions please use [the dedicated Google Groups forum](https://groups.google.com/forum/?fromgroups#!forum/catch-forum)
  24 * See [who else is using Catch](docs/opensource-users.md)
  25
  26 ## Help us out
  27 We're currently running [a survey](https://www.surveymonkey.co.uk/r/TLLYQJW) to help us shape the future of Catch.
  28 Please take a few moments to fill it out (there's only ten questions).