README.in
1CppTest - A C++ Unit Testing Framework
2
3Table of contents
4=================
5
6 - General information
7 - Installation
8 - How to report bugs
9 - Patches
10
11General information
12===================
13
14This is CppTest version @VERSION@. CppTest is a portable and powerful, yet
15simple, unit testing framework for handling automated tests in C++. The focus
16lies on usability and extendability. Several output formats are supported and
17new ones are easily added.
18
19Documentation is either generated (using 'make') or found on the home page.
20Generated documentation is found under 'doc/html', and the starting point is
21'doc/html/index.html'. Code examples are found under 'test'.
22
23The official project home is: https://github.com/cpptest/cpptest
24
25Installation
26============
27
28See the files INSTALL.quick and INSTALL.
29
30How to report bugs
31==================
32
33Bugs should be reported to the bug tracking system (see the official web site).
34You will need to create an account on GitHub for yourself.
35
36In the bug report please include:
37
38- Information about your system and CppTest version.
39
40- How to reproduce the bug.
41 If possible, please include a short test program that reproduces the behavoir.
42 As a last resort, you can also provide a pointer to a larger piece
43 of software that can be downloaded.
44
45- Crash information.
46 If the bug was a crash, supply the exact text that was printed out when the
47 crash occured.
48
49- Further information such as stack traces may also be useful.
50
51- If possible, provide a patch.
52
53- Any other relevant information.
54
55Patches
56=======
57
58Patches should also be submitted to the bug tracking system (see above). If the
59patch fixes an existing bug, add the patch as an attachment to that bug report.
60
61Otherwise, enter a new bug report that describes the patch, and attach the
62patch to that bug report. Please use the PATCH keyword in Bugzilla.
63
64Patches should be in unified diff form, that is, using the -u option to
65GNU diff.
66
67