1UnitTest++
2===========
3
4UnitTest++ is a lightweight unit testing framework for C++. It was designed to do test-driven development on a wide variety of platforms. Simplicity, portability, speed, and small footprint are all very important aspects of UnitTest++. UnitTest++ is ANSI portable C++ and makes minimal use of advanced library and languages features, which means it should be easily portable to just about any platform. Out of the box, the following platforms are supported:
5
6* Windows
7* Linux
8* Mac OS X
9
10Documentation
11--------------
12The full documentation for building and using UnitTest++ can be found on the [GitHub wiki page](https://github.com/unittest-cpp/unittest-cpp/wiki). The contents of this wiki are also included as a git submodule under the `docs` folder, so version-specific Markdown documentation is always available along with the download.
13
14Pre-requisites
15---------------
16While there are currently some bundled makefiles and projects, UnitTest++ is primarily built and supported using [CMake](http://cmake.org).
17
18Downloading
19------------
20### Latest (HEAD) ###
21
22Via git:
23
24    git clone https://github.com/unittest-cpp/unittest-cpp
25
26Via svn:
27
28    svn checkout https://github.com/unittest-cpp/unittest-cpp/trunk unittest-cpp
29
30### Latest release (v1.4) ###
31
32Via git:
33
34    git clone https://github.com/unittest-cpp/unittest-cpp
35    cd unittest-cpp
36    git checkout v1.4
37
38Via svn:
39
40    svn checkout https://github.com/unittest-cpp/unittest-cpp/tags/v1.4 unittest-cpp
41
42License
43---------
44*UnitTest++ is free software. You may copy, distribute, and modify it under
45the terms of the License contained in the file LICENSE distributed
46with this package. This license is the same as the MIT/X Consortium
47license.*
48
49Contributors
50--------------
51### [GitHub Contributor Graph](https://github.com/unittest-cpp/unittest-cpp/contributors) ###
52
53### Current Maintainers: ###
54* Patrick Johnmeyer ([email protected]) @pjohnmeyer
55* Charles Nicholson ([email protected]) @charlesnicholson
56
57### Original Authors: ###
58* Noel Llopis ([email protected])
59* Charles Nicholson ([email protected])
60
61### Contributors not included in github history ###
62* Jim Tilander
63* Kim Grasman
64* Jonathan Jansson
65* Dirck Blaskey
66* Rory Driscoll
67* Dan Lind
68* Matt Kimmel -- Submitted with permission from Blue Fang Games
69* Anthony Moralez
70* Jeff Dixon
71* Randy Coulman
72* Lieven van der Heide
73
74Historic release notes
75----------------------
76
77### Version 1.4 (2008-10-30) ###
78- CHECK macros work at arbitrary stack depth from inside TESTs.
79- Remove obsolete TEST_UTILITY macros
80- Predicated test execution (via TestRunner::RunTestsIf)
81- Better exception handling for fixture ctors/dtors.
82- VC6/7/8/9 support
83
84### Version 1.3 (2007-4-22) ###
85- Removed dynamic memory allocations (other than streams)
86- MinGW support
87- Consistent (native) line endings
88- Minor bug fixing
89
90### Version 1.2 (2006-10-29) ###
91- First pass at documentation.
92- More detailed error crash catching in fixtures.
93- Standard streams used for printing objects under check. This should allow the
94  use of standard class types such as std::string or other custom classes with
95  stream operators to ostream.
96- Standard streams can be optionally compiled off by defining UNITTEST_USE_CUSTOM_STREAMS
97  in Config.h
98- Added named test suites
99- Added CHECK_ARRAY2D_CLOSE
100- Posix library name is libUnitTest++.a now
101- Floating point numbers are postfixed with 'f' in the failure reports
102
103### Version 1.1 (2006-04-18) ###
104- CHECK macros do not have side effects even if one of the parameters changes state
105- Removed CHECK_ARRAY_EQUAL (too similar to CHECK_ARRAY_CLOSE)
106- Added local and global time constraints
107- Removed dependencies on strstream
108- Improved Posix signal to exception translator
109- Failing tests are added to Visual Studio's error list
110- Fixed Visual Studio projects to work with spaces in directories
111
112### Version 1.0 (2006-03-15) ###
113- Initial release
114
115