Setup.md

Setup

Contents

• I have nothing
• I have code but no tests
• I have tests and code and want to add Approval Tests

There are three different places you might be starting your setup from.

Here's how to set up from:

I have nothing

If you just want to start doing some TDD with Approval Tests:

1. download the ApprovalTests.cpp.StarterProject
2. download a Supported Diff Tool
3. Run the existing tests from the project (they should pass).
4. Then open the file tests/NewTest.cpp, choose which of the three starting points you want, and Go!

I have code but no tests

Choose a testing framework.

Then continue to the next section...

I have tests and code and want to add Approval Tests

1. Download the single header file
2. Do one of:
   • Add a wrapper header
   • Rename the header file to ApprovalTests.hpp (removing its version number)
3. Set up your main() (this is framework-dependent:
   • Using Approval Tests With Catch
   • Using Approval Tests With Google Tests
   • Using Approval Tests With Doctest
4. Download a Supported Diff Tool

If you current test framework is not supported, see Supporting a new test framework

---

Back to User Guide