From e8225052f18773960c04b8db253144c03e70c3fb Mon Sep 17 00:00:00 2001 From: Martin Moene Date: Thu, 24 Aug 2017 15:21:36 +0200 Subject: [PATCH] Add html anchor 'top' --- README.md | 1 + docs/Readme.md | 1 + docs/assertions.md | 3 ++- docs/build-systems.md | 1 + docs/command-line.md | 1 + docs/commercial-users.md | 1 + docs/configuration.md | 1 + docs/contributing.md | 3 ++- docs/event-listeners.md | 1 + docs/limitations.md | 1 + docs/logging.md | 3 ++- docs/matchers.md | 3 ++- docs/opensource-users.md | 1 + docs/own-main.md | 1 + docs/release-notes.md | 1 + docs/release-process.md | 1 + docs/reporters.md | 3 ++- docs/slow-compiles.md | 3 ++- docs/test-cases-and-sections.md | 1 + docs/test-fixtures.md | 1 + docs/tostring.md | 1 + docs/tutorial.md | 1 + docs/why-catch.md | 3 ++- 23 files changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b46c6825..f9ac378a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + ![catch logo](catch-logo-small.png) [![Github Releases](https://img.shields.io/github/release/philsquared/catch.svg)](https://github.com/philsquared/catch/releases) diff --git a/docs/Readme.md b/docs/Readme.md index 36048ff8..27aaedb4 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,3 +1,4 @@ + To get the most out of Catch, start with the [tutorial](tutorial.md). Once you're up and running consider the following reference material. diff --git a/docs/assertions.md b/docs/assertions.md index 6f390448..d6699eef 100644 --- a/docs/assertions.md +++ b/docs/assertions.md @@ -1,3 +1,4 @@ + # Assertion Macros Most test frameworks have a large collection of assertion macros to capture all possible conditional forms (```_EQUALS```, ```_NOTEQUALS```, ```_GREATER_THAN``` etc). @@ -145,4 +146,4 @@ For more details, along with workarounds, see the section on [the limitations pa --- -[Home](Readme.md) \ No newline at end of file +[Home](Readme.md) diff --git a/docs/build-systems.md b/docs/build-systems.md index b9644e53..30d99c14 100644 --- a/docs/build-systems.md +++ b/docs/build-systems.md @@ -1,3 +1,4 @@ + # CI and build system integration Build Systems may refer to low-level tools, like CMake, or larger systems that run on servers, like Jenkins or TeamCity. This page will talk about both. diff --git a/docs/command-line.md b/docs/command-line.md index cc944734..8b546126 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -1,3 +1,4 @@ + Catch works quite nicely without any command line options at all - but for those times when you want greater control the following options are available. Click one of the followings links to take you straight to that option - or scroll on to browse the available options. diff --git a/docs/commercial-users.md b/docs/commercial-users.md index 424eb22c..60101441 100644 --- a/docs/commercial-users.md +++ b/docs/commercial-users.md @@ -1,3 +1,4 @@ + # Commercial users of Catch As well as [Open Source](opensource-users.md) users Catch is widely used within proprietary code bases too. diff --git a/docs/configuration.md b/docs/configuration.md index 59712020..d2003065 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,3 +1,4 @@ + Catch is designed to "just work" as much as possible. For most people the only configuration needed is telling Catch which source file should host all the implementation code (```CATCH_CONFIG_MAIN```). Nonetheless there are still some occasions where finer control is needed. For these occasions Catch exposes a set of macros for configuring how it is built. diff --git a/docs/contributing.md b/docs/contributing.md index 1bcef99b..ab831d4c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,3 +1,4 @@ + # Contributing to Catch So you want to contribute something to Catch? That's great! Whether it's a bug fix, a new feature, support for @@ -57,4 +58,4 @@ be fairly self-explanatory. --- -[Home](Readme.md) \ No newline at end of file +[Home](Readme.md) diff --git a/docs/event-listeners.md b/docs/event-listeners.md index 58c2d8db..a63b3ba2 100644 --- a/docs/event-listeners.md +++ b/docs/event-listeners.md @@ -1,3 +1,4 @@ + # Event Listeners A `Listener` is a class you can register with Catch that will then be passed events, diff --git a/docs/limitations.md b/docs/limitations.md index 60ea0de2..8c192320 100644 --- a/docs/limitations.md +++ b/docs/limitations.md @@ -1,3 +1,4 @@ + # Known limitations Catch has some known limitations, that we are not planning to change. Some of these are caused by our desire to support C++98 compilers, some of these are caused by our desire to keep Catch crossplatform, some exist because their priority is seen as low compared to the development effort they would need and some other yet are compiler/runtime bugs. diff --git a/docs/logging.md b/docs/logging.md index afbfd224..88adfc8b 100644 --- a/docs/logging.md +++ b/docs/logging.md @@ -1,3 +1,4 @@ + # Logging macros Additional messages can be logged during a test case. Note that the messages are scoped and thus will not be reported if failure occurs in scope preceding the message declaration. An example: @@ -79,4 +80,4 @@ These macros are now deprecated and are just aliases for INFO and CAPTURE (which --- -[Home](Readme.md) \ No newline at end of file +[Home](Readme.md) diff --git a/docs/matchers.md b/docs/matchers.md index 5daf68d7..acbcbb85 100644 --- a/docs/matchers.md +++ b/docs/matchers.md @@ -1,3 +1,4 @@ + # Matchers Matchers are an alternative way to do assertions which are easily extensible and composable. @@ -101,4 +102,4 @@ with expansion: --- -[Home](Readme.md) \ No newline at end of file +[Home](Readme.md) diff --git a/docs/opensource-users.md b/docs/opensource-users.md index f1e1806a..c1e93d0f 100644 --- a/docs/opensource-users.md +++ b/docs/opensource-users.md @@ -1,3 +1,4 @@ + # Open Source projects using Catch Catch is great for open source. With it's [liberal license](../LICENSE.txt) and single-header, dependency-free, distribution diff --git a/docs/own-main.md b/docs/own-main.md index 8ab0077e..2b6d032e 100644 --- a/docs/own-main.md +++ b/docs/own-main.md @@ -1,3 +1,4 @@ + # Supplying main() yourself The easiest way to use Catch is to let it supply ```main()``` for you and handle configuring itself from the command line. diff --git a/docs/release-notes.md b/docs/release-notes.md index c6c91ce1..d9c658fd 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,3 +1,4 @@ + # 2.0.0 (in progress) ## Breaking changes diff --git a/docs/release-process.md b/docs/release-process.md index 725779ea..34002ae6 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -1,3 +1,4 @@ + # How to release When enough changes have accumulated, it is time to release new version of Catch. This document describes the proces in doing so, that no steps are forgotten. Note that all referenced scripts can be found in the `scripts/` directory. diff --git a/docs/reporters.md b/docs/reporters.md index 4ae0ce71..7c8e4204 100644 --- a/docs/reporters.md +++ b/docs/reporters.md @@ -1,3 +1,4 @@ + # Reporters Catch has a modular reporting system and comes bundled with a handful of useful reporters built in. @@ -42,4 +43,4 @@ but do keep in mind upcoming changes (these will be minor, simplifying, changes --- -[Home](Readme.md) \ No newline at end of file +[Home](Readme.md) diff --git a/docs/slow-compiles.md b/docs/slow-compiles.md index a12d0867..0b609f68 100644 --- a/docs/slow-compiles.md +++ b/docs/slow-compiles.md @@ -1,3 +1,4 @@ + # Why do my tests take so long to compile? Several people have reported that test code written with Catch takes much longer to compile than they would expect. Why is that? @@ -61,4 +62,4 @@ You can also opt to sacrifice some features in order to speed-up Catch's compila --- -[Home](Readme.md) \ No newline at end of file +[Home](Readme.md) diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md index 4e53c35c..45269044 100644 --- a/docs/test-cases-and-sections.md +++ b/docs/test-cases-and-sections.md @@ -1,3 +1,4 @@ + # Test cases and sections While Catch fully supports the traditional, xUnit, style of class-based fixtures containing test case methods this is not the preferred style. diff --git a/docs/test-fixtures.md b/docs/test-fixtures.md index fc546b39..bfbd0aa3 100644 --- a/docs/test-fixtures.md +++ b/docs/test-fixtures.md @@ -1,3 +1,4 @@ + Although Catch allows you to group tests together as sections within a test case, it can still be convenient, sometimes, to group them using a more traditional test fixture. Catch fully supports this too. You define the test fixture as a simple structure: ```c++ diff --git a/docs/tostring.md b/docs/tostring.md index 05a6b79b..8a2939e5 100644 --- a/docs/tostring.md +++ b/docs/tostring.md @@ -1,3 +1,4 @@ + # String conversions Catch needs to be able to convert types you use in assertions and logging expressions into strings (for logging and reporting purposes). diff --git a/docs/tutorial.md b/docs/tutorial.md index 600ba3ba..833d3a02 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -1,3 +1,4 @@ + # Getting Catch 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. diff --git a/docs/why-catch.md b/docs/why-catch.md index 82257d68..fce02bcd 100644 --- a/docs/why-catch.md +++ b/docs/why-catch.md @@ -1,3 +1,4 @@ + # Why do we need yet another C++ test framework? Good question. For C++ there are quite a number of established frameworks, @@ -42,4 +43,4 @@ See the [tutorial](tutorial.md) to get more of a taste of using Catch in practic --- -[Home](Readme.md) \ No newline at end of file +[Home](Readme.md)