3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-12-23 03:43:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Start of new docs

Browse Source
This commit is contained in:
Phil Nash 2013-06-03 20:03:39 +01:00
parent 4e88ccda56
commit 130ec986c7
1 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,11 +1,24 @@
![catch logo](https://raw.github.com/philsquared/Catch/Integration/catch-logo-small.png)
![catch logo](catch-logo-small.png)
## CATCH v0.9 build 38 (integration branch)
An automated test framework for C, C++ and Objective-C.
*v0.9 build 38 (integration branch)*
This branch may contain code that is experimental or not yet fully tested.
The latest stable version can be found on the Master branch.
## What's the Catch?
* For documentation see the wiki at: https://github.com/philsquared/Catch/wiki
* Issues and bugs can be raised at: https://github.com/philsquared/Catch/issues
* For discussion or questions please use: https://groups.google.com/forum/?fromgroups#!forum/catch-forum
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.
## How to use it
This documentation comprises these three parts:
* [Why do we need yet another C++ Unit Test System?](docs/why-catch.md)
* [Tutorial](docs/tutorial.md) - getting started
* [Reference section](docs/reference-index.md) - all the details
## What state is Catch in - can I use it now?
For now Catch is still classed as "in developer preview". However it has already been widely used for over two years. It has proven fairly stable and is in use in some demanding projects. Think of it in the same way that Google uses the term "beta".
At time of writing I'm working towards locking down the public facing interfaces so I can finally give it a 1.0 designation.
## More
* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/philsquared/Catch/issues)
* For discussion or questions please use [the dedicated Google Groups forum](https://groups.google.com/forum/?fromgroups#!forum/catch-forum)