Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
More details about acquiring the library, also broke the getting started section into 2 sections: Acquiring the library and Writing tests.
  • Loading branch information
eljonny authored Mar 17, 2024
1 parent ee8efc1 commit 34caed0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@
This is an implementation of a very simple test framework.
It has no dependencies (other than the C++ standard library)
and relies on C++11 features.

The code is about 380 lines and resulting Debug binary
packages are about 330kb on Linux, while the Release
packages are about 280kb; this includes the header, the
static library, and the CMake targets for including it in
your CMake build.
The Release builds are optimized for speed over size, so the
build could probably be tweaked to get a smaller binary if
desired.

# Features

Expand All @@ -28,6 +37,8 @@ Features of the test framework are very minimal and include:

# Getting Started

## Acquiring the Library

As of 0.1.0-beta.1 this library can be included in a CMake build
using the `find_package` CMake function after installing, like
so:
Expand All @@ -53,6 +64,14 @@ As of 0.1.0-beta.1, you can also include it in your `vcpkg` project
vcpkg add port testcpp
```

You can get binary packages from the Releases page on the GitHub
repo, or get them directly from the latest successful build on
the Actions page from the multi-platform or linux-package
workflows on the repo.
Currently binaries are generated for Linux and Windows.

## Writing Tests

Include the test framework through TestCPP/Test.h, whether you
make it a part of your project or install the files into
the standard install locations (like /usr/local/include/TestCPP
Expand Down

0 comments on commit 34caed0

Please sign in to comment.