Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorPhil Nash2013-06-25 13:21:41 +0100
committerPhil Nash2013-06-25 13:21:41 +0100
commitae1c1ac1a0985ea8114cdd2bbf3c85a4e493fbb7 (patch)
treed467e345667cdfe4565c79543081dab4d44255fd
parent5ddd6e31e48af87df6fbb242af393d38f45fd54b (diff)
downloadcatch3-ae1c1ac1a0985ea8114cdd2bbf3c85a4e493fbb7.tar.gz
Added "what's changed"
-rw-r--r--README.md4
-rw-r--r--docs/whats-changed.md22
2 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index dadfd7d6..2e31f528 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,10 @@
*v0.9 build 39 (integration branch)*
+# New release with significant changes
+
+[Please see this page for details - including some breaking changes](docs/whats-changed.md)
+
## What's the Catch?
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.
diff --git a/docs/whats-changed.md b/docs/whats-changed.md
new file mode 100644
index 00000000..e3187c56
--- /dev/null
+++ b/docs/whats-changed.md
@@ -0,0 +1,22 @@
+## What's new in Catch
+
+This page has been added following quite a large (hopefully the last such) merge from the integration branch. Please read this summary through so you know what to expect (and whether any changes - breaking in some cases - will affect you).
+
+* Calling Catch from your own ```main()``` has changed - please review [the updated docs](own-main.md)
+* The command line has changed. The biggest change is that test case names and tags should now only be supplied as primary arguments - in fact the ```-t``` option has been repurposed to mean "list tags". There are [updated docs for this too](command-line.md)
+* There is a new reporter interface. If you have written a custom reporter you can use the ```LegacyReporterAdapter``` to minimise any differences. Ideally you should update to the new interface - especially as it has been designed to be more robust in the face of future changes (which should be minimal).
+* The docs have moved from the wiki to the repository itself. They consist of a set of markdown files in the docs folder and are referenced directly from the README in the root. You can still read them online from GitHub.
+* Lots of new goodness - more documentation for which is coming. The existing docs have been updated to account for some of the changes already (e.g. variadic macros). A quick rundown:
+ * Variadic macros are used, where possible, so that, e.g. you can write a ```TEST_CASE``` with just a name - or even no name at all (making it an anonymous test case).
+ * The hierarchical naming convention is deprecated in favour of using tags (see next)
+ * ```TEST_CASE```s (but not ```SECTION```s) can now be tagged by placing keywords in square brackets in the second argument - e.g.: ```TEST_CASE( "A nice name", "[tag1][tag2]")```. The old style is still supported but please consider using this new style.
+ * Tests can still be "hidden" using the ```./``` prefix as before, but the preferred way now is to give it the ```[hide]``` tag (hidden tests are skipped if you run the test process without specifying any test specs).
+ * As well as ```TEST_CASE```s and ```SECTION```s you can now also use BDD-style ```SCENARIO``` (in place of ```TEST_CASE```) and ```GIVEN```, ```WHEN``` and ```THEN``` macros (in place of ```SECTION```s).
+ * New command line parser. Under the hood it is a complete rewrite - now powered by a command line library that will soon be spun out as a separate project: Clara. The options themselves are largely the same but there are some notable differences (as already discussed).
+ * Completely overhauled output from the textual reporter (now the Console reporter). This now features a much clearer, cleaner format, including good use of indentation.
+
+If you find any issues please raise issue tickets on the [issue tracker on GitHub](https://github.com/philsquared/Catch/issues) as before. For general questions, comments and suggestions, though, please use the [new forums on Google Groups](https://groups.google.com/forum/?fromgroups#!forum/catch-forum).
+
+---
+
+[Home](../README.md) \ No newline at end of file