]> granicus.if.org Git - check/blob - index.html
Merge pull request #231 from nmeum/makeinfo
[check] / index.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
2 <html xmlns="http://www.w3.org/1999/xhtml">\r
3 \r
4 <!--\r
5 Copyright: Darren Hester 2006, http://www.designsbydarren.com\r
6 License: Released Under the "Creative Commons License",\r
7 http://creativecommons.org/licenses/by-nc/2.5/\r
8 -->\r
9 \r
10 <head>\r
11 \r
12 <!-- Meta Data -->\r
13 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />\r
14 <meta name="description" content="Check unit testing framework for C" />\r
15 <meta name="keywords" content="check, unit test, c" />\r
16 \r
17 <!-- Site Title -->\r
18 <title>Check | Unit testing framework for C</title>\r
19 \r
20 <!-- Link to Style External Sheet -->\r
21 <link href="web/css/style.css" type="text/css" rel="stylesheet" />\r
22 \r
23 </head>\r
24 \r
25 <body>\r
26 \r
27 <div id="page_wrapper">\r
28 \r
29 <div id="header_wrapper">\r
30 \r
31 <div id="header">\r
32 \r
33 <h1>Check</h1>\r
34 <h2>Unit Testing Framework for C</h2>\r
35 \r
36 </div>\r
37 \r
38 <div id="navcontainer">\r
39 \r
40 <ul id="navlist">\r
41 <li id="active"><a href="#" id="current">Home</a></li>\r
42 <li><a href="./NEWS">NEWS</a></li>\r
43 <li><a href="./web/install.html">Install</a></li>\r
44 <li><a href="./doc/doxygen/html/check_8h.html">API</a></li>\r
45 <li><a href="./doc/check_html/check_3.html">Tutorial</a></li>\r
46 <li><a href="./doc/check_html/index.html">Reference</a></li>\r
47 <li><a href="https://github.com/libcheck/check/releases">Download</a></li>\r
48 </ul>\r
49 </div>\r
50 \r
51 </div>\r
52 \r
53 <div id="left_side">\r
54 \r
55 <h3>Latest Check Release</h3>\r
56 \r
57 <p>\r
58 <!-- Update this section during a release -->\r
59 <b>Oct 20, 2019:</b> Check 0.13.0 <a href="https://github.com/libcheck/check/releases">\r
60 is now available for download</a>. Check is available under the\r
61 <a href="./COPYING.LESSER">LGPL license</a>. New features available in\r
62 this release are listed on the <a href="./NEWS">NEWS</a> page.\r
63 </p>\r
64 \r
65 <h3>About Project</h3>\r
66 <p>\r
67 <ul>\r
68 <li><a href="https://github.com/libcheck/check">Project Page</a></li>\r
69 <li><a href="./COPYING.LESSER">LGPL License</a></li>\r
70 <li><a href="./web/users-of-check.html">Users of Check</a></li>\r
71 <li><a href="https://lists.sourceforge.net/lists/listinfo/check-users">Mailing list</a></li>\r
72 <li><a href="https://buildfarm.opencsw.org/buildbot/waterfall?builder=libcheck-solaris10-amd64&builder=libcheck-solaris10-i386&builder=libcheck-solaris10-sparc&builder=libcheck-solaris10-sparcv9&reload=6">OpenCSW BuildBot</a></li>\r
73 </ul>\r
74 </p>\r
75 </div>\r
76 \r
77 \r
78 <div id="content">\r
79 \r
80 <h3>What is Check?</h3>\r
81 \r
82 <p>\r
83 Check is a unit testing framework for C. It features a simple interface\r
84 for defining unit tests, putting little in the way of the developer.\r
85 Tests are run in a separate address space, so both assertion failures\r
86 and code errors that cause segmentation faults or other signals can be\r
87 caught. Test results are reportable in the following: Subunit,\r
88 TAP, XML, and a generic logging format.\r
89 </p>\r
90 \r
91 <h3>Supported Platforms</h3>\r
92 \r
93 <p>\r
94 Check works on many UNIX compatible environments, such as GNU/Linux,\r
95 GNU/Hurd, BSD, and Mac OSX. Windows support is available through the Cygwin,\r
96 MinGW, and MinGW-w64 platforms, as well as with MSVC using Visual Studios or\r
97 CMake/NMake. If Check is compiled on a platform with some\r
98 POSIX functions unavailable (such as fork), Check will disable the\r
99 related features but still remain functional. Look at the\r
100 <a href="./web/install.html">Install</a> page for installation instructions\r
101 per platform.\r
102 </p>\r
103 \r
104 <h3>Support</h3>\r
105 \r
106 <p>\r
107 Questions are accepted on the mailing list\r
108 <a href="https://lists.sourceforge.net/lists/listinfo/check-users">check-users@sourceforge.net</a>\r
109 and bugs and feature requests can be submitted via the Github\r
110 page <a href="https://github.com/libcheck/check/issues">here</a>.\r
111 </p>\r
112 \r
113 <h3>Contributing</h3>\r
114 \r
115 <p>\r
116 The authors welcome any and all help with Check, whether through\r
117 enhancement requests, bug reports, patches, or documentation. Please visit\r
118 the Check <a href="https://github.com/libcheck/check">project page</a>.\r
119 </p>\r
120 \r
121 <p>\r
122 Patches to Check, unless trivial, should be against the master branch,\r
123 and should include a full set of unit tests verifying the new behavior. No\r
124 functionality goes into Check without unit tests, and submitting a\r
125 merge request without automated testing will delay potential acceptable of the patch.\r
126 </p>\r
127 \r
128 <p>\r
129 The latest Check source can be browsed\r
130 <a href="https://github.com/libcheck/check">here</a>\r
131 or retrieved with git using the following:\r
132 <div id="code"><pre class="command">git clone https://github.com/libcheck/check.git</pre></div>\r
133 </p>\r
134 \r
135 </div>\r
136 \r
137 <div id="footer">\r
138 <a href="https://github.com/">Github</a>\r
139 | <a href="http://www.cloudbees.com/foss/index.cb">Cloudbees</a>\r
140 <br />\r
141 Template provided by:\r
142 <a href="http://www.designsbydarren.com" target="_blank">DesignsByDarren.com</a>\r
143 </div>\r
144 \r
145 </div>\r
146 \r
147 </body>\r
148 \r
149 </html>\r