From 02ca5a40a904ff792f1c94e502ac79781dcdd784 Mon Sep 17 00:00:00 2001 From: Kris Jusiak Date: Mon, 23 Dec 2019 21:32:17 -0700 Subject: [PATCH] :books: [README] Reference menu --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 02351bcc..522a9c64 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ -
Motivation +
Motivation

Testing is a very important part of the Software Development, however, C++ doesn't provide any good testing facilities out of the box, @@ -88,7 +88,7 @@ Sounds intriguing/interesting? Learn more at:

-
Quick Start +
Quick Start

@@ -119,7 +119,7 @@ Sounds intriguing/interesting? Learn more at:

Tutorial

-

    Step 0: Get it... +
    Step 0: Get it...

> Get the latest latest header/module from [here!](https://github.com/boost-experimental/ut/blob/master/include/boost/ut.hpp) @@ -154,7 +154,7 @@ cd build && make install # install

-
    Step 1: Expect it... +
    Step 1: Expect it...

> Let's write our first assertion, shall we? @@ -294,7 +294,7 @@ asserts: 1 | 0 passed | 1 failed

-
    Step 2: Group it... +
    Step 2: Group it...

> Assertions are great, but how to combine them into more cohesive units? @@ -421,7 +421,7 @@ All tests passed (3 asserts in 3 tests)

-
    Step 3: Scale it... +
    Step 3: Scale it...

> Okay, but my project is more complex than that. How can I scale? @@ -464,7 +464,7 @@ All tests passed (2 asserts in 2 tests)

Examples

-

    Assertions +
    Assertions

```cpp @@ -527,10 +527,10 @@ asserts: 24 | 22 passed | 2 failed

-
    Tests +
    Tests

-

        Run/Skip +
        Run/Skip

```cpp @@ -568,7 +568,7 @@ All tests passed (1 asserts in 1 tests)

-
        Sections +
        Sections

```cpp @@ -600,7 +600,7 @@ All tests passed (4 asserts in 1 tests)

-
        Parameterized +
        Parameterized

```cpp @@ -634,7 +634,7 @@ All tests passed (11 asserts in 7 tests)

-
        Behavior Driven Development (BDD) +
        Behavior Driven Development (BDD)

```cpp @@ -660,7 +660,7 @@ All tests passed (2 asserts in 1 tests)

-
    Suites +
    Suites

```cpp @@ -690,10 +690,10 @@ All tests passed (2 asserts in 2 tests)

-
    Misc +
    Misc

-

        Logging +
        Logging

```cpp @@ -722,7 +722,7 @@ asserts: 1 | 0 passed | 1 failed

-
        Matchers +
        Matchers

```cpp @@ -747,7 +747,7 @@ All tests passed (1 asserts in 1 tests)

-
        Exceptions/Aborts +
        Exceptions/Aborts

```cpp @@ -772,10 +772,10 @@ All tests passed (4 asserts in 1 tests)

-
    Config +
    Config

-

        Runner +
        Runner

```cpp @@ -801,7 +801,7 @@ template<> auto ut::cfg = cfg::runner{};

-
        Reporter +
        Reporter

```cpp @@ -834,7 +834,7 @@ auto ut::cfg = ut::runner{};

-
        Printer +
        Printer

```cpp @@ -876,7 +876,7 @@ int main() {

User Guide

-

    API +
    API

```cpp @@ -1240,7 +1240,7 @@ namespace boost::ut::inline v1_1_4 {

-
    Configuration +
    Configuration

| Option | Description | Example | @@ -1259,10 +1259,10 @@ namespace boost::ut::inline v1_1_4 { -

FAQ +
FAQ

-

    C++20 features? +
    C++20 features?

* API @@ -1288,7 +1288,7 @@ namespace boost::ut::inline v1_1_4 {

-
    How does it work? +
    How does it work?

> `suite` @@ -1434,7 +1434,7 @@ namespace boost::ut::inline v1_1_4 {

-
    Can I still use macros? +
    Can I still use macros?

> Sure, however, be aware that they will be exposed in the `global scope` @@ -1477,7 +1477,7 @@ All tests passed (4 asserts in 3 tests)

-
    Is standardization an option? +
    Is standardization an option?

> Personally, I believe that C++ standard could benefit from common testing primitives (`expect`, `""_test`) because @@ -1493,7 +1493,7 @@ All tests passed (4 asserts in 3 tests)

-
    What about Mocks/Stubs/Fakes? +
    What about Mocks/Stubs/Fakes?

> Consider integrating one of the following frameworks