From 7423a481ebce4e78861e7148fd2777c91edf928c Mon Sep 17 00:00:00 2001 From: Phil Nash Date: Fri, 3 Nov 2017 13:05:09 +0000 Subject: [PATCH] Updated some Catch references to Catch2 --- README.md | 16 ++++++++-------- docs/Readme.md | 2 +- docs/tutorial.md | 12 ++++++------ 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 0d1b9649..a4b505c7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ ![catch logo](catch-logo-small.png) -[![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/philsquared/catch/releases) -[![Build Status](https://travis-ci.org/philsquared/Catch.svg?branch=catch2)](https://travis-ci.org/philsquared/Catch?branch=catch2) -[![Build status](https://ci.appveyor.com/api/projects/status/hrtk60hv6tw6fght/branch/catch2?svg=true)](https://ci.appveyor.com/project/philsquared/catch/branch/catch2) +[![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/catchorg/catch2/releases) +[![Build Status](https://travis-ci.org/philsquared/Catch.svg?branch=catch2)](https://travis-ci.org/philsquared/Catch) +[![Build status](https://ci.appveyor.com/api/projects/status/hrtk60hv6tw6fght/branch/catch2?svg=true)](https://ci.appveyor.com/project/philsquared/catch) -The latest version of the single header can be downloaded directly using this link +The latest version of the single header can be downloaded directly using this link ## What's the Catch? -Catch stands for C++ Automated Test Cases in Headers and is a +Catch2 stands for C++ Automated Test Cases in a Header and is a multi-paradigm test framework for C++. which also supports Objective-C -and, maybe, C. +(and maybe C). It is primarily distributed as a single header file, although certain extensions may require additional headers. @@ -23,6 +23,6 @@ This documentation comprises these three parts: * [Reference section](docs/Readme.md#top) - all the details ## More -* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/philsquared/Catch/issues) +* Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/catchorg/Catch2/issues) * For discussion or questions please use [the dedicated Google Groups forum](https://groups.google.com/forum/?fromgroups#!forum/catch-forum) -* See [who else is using Catch](docs/opensource-users.md#top) +* See [who else is using Catch2](docs/opensource-users.md#top) diff --git a/docs/Readme.md b/docs/Readme.md index e7815671..be7d1cd1 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,7 +1,7 @@ # Reference -To get the most out of Catch, start with the [tutorial](tutorial.md#top). +To get the most out of Catch2, start with the [tutorial](tutorial.md#top). Once you're up and running consider the following reference material. Writing tests: diff --git a/docs/tutorial.md b/docs/tutorial.md index 1b55bcf1..2d92d0be 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -2,7 +2,7 @@ # Tutorial **Contents**
-[Getting Catch](#getting-catch)
+[Getting Catch2](#getting-catch2)
[Where to put it?](#where-to-put-it)
[Writing tests](#writing-tests)
[Test cases and sections](#test-cases-and-sections)
@@ -10,18 +10,18 @@ [Scaling up](#scaling-up)
[Next steps](#next-steps)
-## Getting Catch +## Getting Catch2 -The simplest way to get Catch is to download the latest [single header version](https://raw.githubusercontent.com/philsquared/Catch/master/single_include/catch.hpp). The single header is generated by merging a set of individual headers but it is still just normal source code in a header file. +The simplest way to get Catch2 is to download the latest [single header version](https://raw.githubusercontent.com/CatchOrg/Catch2/master/single_include/catch.hpp). The single header is generated by merging a set of individual headers but it is still just normal source code in a header file. -The full source for Catch, including test projects, documentation, and other things, is hosted on GitHub. [http://catch-lib.net](http://catch-lib.net) will redirect you there. +The full source for Catch2, including test projects, documentation, and other things, is hosted on GitHub. [http://catch-lib.net](http://catch-lib.net) will redirect you there. ## Where to put it? -Catch is header only. All you need to do is drop the file(s) somewhere reachable from your project - either in some central location you can set your header search path to find, or directly into your project tree itself! This is a particularly good option for other Open-Source projects that want to use Catch for their test suite. See [this blog entry for more on that](http://www.levelofindirection.com/journal/2011/5/27/unit-testing-in-c-and-objective-c-just-got-ridiculously-easi.html). +Catch2 is header only. All you need to do is drop the file somewhere reachable from your project - either in some central location you can set your header search path to find, or directly into your project tree itself! This is a particularly good option for other Open-Source projects that want to use Catch for their test suite. See [this blog entry for more on that](http://www.levelofindirection.com/journal/2011/5/27/unit-testing-in-c-and-objective-c-just-got-ridiculously-easi.html). -The rest of this tutorial will assume that the Catch single-include header (or the include folder) is available unqualified - but you may need to prefix it with a folder name if necessary. +The rest of this tutorial will assume that the Catch2 single-include header (or the include folder) is available unqualified - but you may need to prefix it with a folder name if necessary. ## Writing tests