Create gh-pages branch via GitHub
This commit is contained in:
Franklin Mathieu
parent
7a37e8cd12
commit
8d72b14024
2 changed files with 38 additions and 25 deletions
61
index.html
61
index.html
|
|
@ -1,6 +1,6 @@
|
|||
<!doctype html>
|
||||
<!-- The Time Machine GitHub pages theme was designed and developed by Jon Rohan, on Feb 7, 2012. -->
|
||||
<!-- Follow him for fun. http://twitter.com/jonrohan. Tail his code on http://github.com/jonrohan -->
|
||||
<!-- Follow him for fun. http://twitter.com/jonrohan. Tail his code on https://github.com/jonrohan -->
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
|
@ -39,12 +39,12 @@
|
|||
<h1>
|
||||
<a id="criterion" class="anchor" href="#criterion" aria-hidden="true"><span class="octicon octicon-link"></span></a>Criterion</h1>
|
||||
|
||||
<p><a href="https://travis-ci.org/Snaipe/Criterion"><img src="https://travis-ci.org/Snaipe/Criterion.svg?branch=master" alt="Build Status"></a>
|
||||
<a href="https://coveralls.io/r/Snaipe/Criterion?branch=master"><img src="https://coveralls.io/repos/Snaipe/Criterion/badge.svg?branch=master" alt="Coverage Status"></a>
|
||||
<a href="https://github.com/Snaipe/Criterion/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License"></a>
|
||||
<a href="https://github.com/Snaipe/Criterion/releases"><img src="https://img.shields.io/github/tag/Snaipe/Criterion.svg?label=version&style=flat" alt="Version"></a></p>
|
||||
<p><a href="https://travis-ci.org/Snaipe/Criterion"><img src="https://travis-ci.org/Snaipe/Criterion.svg?branch=master" alt="Build Status"></a>
|
||||
<a href="https://coveralls.io/r/Snaipe/Criterion?branch=master"><img src="https://coveralls.io/repos/Snaipe/Criterion/badge.svg?branch=master" alt="Coverage Status"></a>
|
||||
<a href="https://github.com/Snaipe/Criterion/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License"></a>
|
||||
<a href="https://github.com/Snaipe/Criterion/releases"><img src="https://img.shields.io/github/tag/Snaipe/Criterion.svg?label=version&style=flat" alt="Version"></a> </p>
|
||||
|
||||
<p>A dead-simple, yet extensible, C test framework.</p>
|
||||
<p>A dead-simple, yet extensible, C unit testing framework.</p>
|
||||
|
||||
<p><img src="https://raw.githubusercontent.com/Snaipe/Criterion/bleeding/doc/screencast.gif" alt="Screencast"></p>
|
||||
|
||||
|
|
@ -62,14 +62,29 @@ these suits, and finally call the right functions.</p>
|
|||
the user would have with other frameworks:</p>
|
||||
|
||||
<ul>
|
||||
<li>Tests are automatically registered when declared.</li>
|
||||
<li>A default entry point is provided, no need to declare a main
|
||||
<li>[x] Tests are automatically registered when declared.</li>
|
||||
<li>[x] Implements a xUnit framework structure.</li>
|
||||
<li>[x] A default entry point is provided, no need to declare a main
|
||||
unless you want to do special handling.</li>
|
||||
<li>Test are isolated in their own process, crashes and signals can be
|
||||
<li>[x] Test are isolated in their own process, crashes and signals can be
|
||||
reported and tested.</li>
|
||||
<li>Progress and statistics can be followed in real time with report hooks.</li>
|
||||
<li>[x] Progress and statistics can be followed in real time with report hooks.</li>
|
||||
<li>[x] TAP output format can be enabled with an option.</li>
|
||||
<li>[x] Runs on Linux, FreeBSD, Mac OS X, and Windows (Compiles only with MinGW or Cygwin).</li>
|
||||
</ul>
|
||||
|
||||
<h2>
|
||||
<a id="downloads" class="anchor" href="#downloads" aria-hidden="true"><span class="octicon octicon-link"></span></a>Downloads</h2>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-linux-x86_64.tar.bz2">Linux (x86_64)</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-osx-x86_64.tar.bz2">OS X (x86_64)</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-win-x86_64.tar.bz2">Windows (x86_64)</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-freebsd-x86_64.tar.bz2">FreeBSD (x86_64)</a></li>
|
||||
</ul>
|
||||
|
||||
<p>If you have a different platform, you can still <a href="http://criterion.readthedocs.org/en/latest/setup.html#installation">build the library from source</a></p>
|
||||
|
||||
<h2>
|
||||
<a id="documentation" class="anchor" href="#documentation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Documentation</h2>
|
||||
|
||||
|
|
@ -79,19 +94,21 @@ reported and tested.</li>
|
|||
<h2>
|
||||
<a id="samples" class="anchor" href="#samples" aria-hidden="true"><span class="octicon octicon-link"></span></a>Samples</h2>
|
||||
|
||||
<p>Sample tests can be found in the <a href="https://github.com/Snaipe/Criterion/tree/master/samples">sample directory</a>.</p>
|
||||
<p>Sample tests can be found in the <a href="https://github.com/Snaipe/Criterion/tree/bleeding/samples/">sample directory</a>.</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/master/samples/simple.c">A simple test</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/master/samples/suites.c">Using multiple suites</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/master/samples/signal.c">Tests with signals</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/master/samples/report.c">Using report hooks</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/samples/simple.c">A simple test</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/samples/suites.c">Using multiple suites</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/samples/asserts.c">Writing assertions</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/samples/fixtures.c">Adding test fixtures</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/samples/signal.c">Tests with signals</a></li>
|
||||
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/samples/report.c">Using report hooks</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>
|
||||
<a id="faq" class="anchor" href="#faq" aria-hidden="true"><span class="octicon octicon-link"></span></a>F.A.Q.</h2>
|
||||
|
||||
<p><strong>Q. What's wrong with other test frameworks?</strong>
|
||||
<p><strong>Q. What's wrong with other test frameworks?</strong><br>
|
||||
A. I worked with CUnit and Check, and I must say that they do their job
|
||||
very well -- the only thing that bugs me is that setting up a test
|
||||
suite from scratch is a pain, it should really be simpler. Most
|
||||
|
|
@ -100,14 +117,10 @@ A. I worked with CUnit and Check, and I must say that they do their job
|
|||
main, manually register suites, then tests. Criterion tries to
|
||||
fix these shortcomings.</p>
|
||||
|
||||
<p><strong>Q. Where has this been tested?</strong>
|
||||
<p><strong>Q. Where has this been tested?</strong><br>
|
||||
A. Currently, on Linux 2.6.32 and Linux 3.15.7, although it should work on
|
||||
most *nix systems. More tests will be added on the build matrix.</p>
|
||||
|
||||
<p><strong>Q. Will this work under Windows/MSVC?</strong>
|
||||
A. Windows support with MinGW/MSVC is coming, but MSVC is a bit of a lost cause
|
||||
to compile the library itself: the project internally uses c99 features and gnu
|
||||
extensions.</p>
|
||||
most *nix systems; Mac OS X Yosemite 10.10, FreeBSD 10.0, and finally
|
||||
Windows 7 (with the MinGW and Cygwin ports of GCC).</p>
|
||||
</article>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -118,7 +131,7 @@ A. Windows support with MinGW/MSVC is coming, but MSVC is a bit of a lost cause
|
|||
|
||||
</div>
|
||||
<div class="creds">
|
||||
<small>This page generated using <a href="http://pages.github.com/">GitHub Pages</a><br>theme by <a href="https://twitter.com/jonrohan/">Jon Rohan</a></small>
|
||||
<small>This page generated using <a href="https://pages.github.com/">GitHub Pages</a><br>theme by <a href="https://twitter.com/jonrohan/">Jon Rohan</a></small>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
{"name":"Criterion","tagline":"A KISS, non-intrusive C test framework","body":"\r\nCriterion\r\n=========\r\n\r\n[](https://travis-ci.org/Snaipe/Criterion)\r\n[](https://coveralls.io/r/Snaipe/Criterion?branch=master)\r\n[](https://github.com/Snaipe/Criterion/blob/master/LICENSE)\r\n[](https://github.com/Snaipe/Criterion/releases)\r\n\r\nA dead-simple, yet extensible, C test framework.\r\n\r\n\r\n\r\n## Philosophy\r\n\r\nMost test frameworks for C require a lot of boilerplate code to\r\nset up tests and test suites -- you need to create a main,\r\nthen register new test suites, then register the tests within\r\nthese suits, and finally call the right functions.\r\n\r\nThis gives the user great control, at the unfortunate cost of simplicity.\r\n\r\nCriterion follows the KISS principle, while keeping the control\r\nthe user would have with other frameworks:\r\n\r\n* Tests are automatically registered when declared.\r\n* A default entry point is provided, no need to declare a main\r\n unless you want to do special handling.\r\n* Test are isolated in their own process, crashes and signals can be\r\n reported and tested.\r\n* Progress and statistics can be followed in real time with report hooks.\r\n\r\n## Documentation\r\n\r\nAn online documentation is available on [ReadTheDocs][online-docs]\r\n([PDF][pdf-docs] | [Zip][zip-docs] | [Epub][epub-docs])\r\n\r\n## Samples\r\n\r\nSample tests can be found in the [sample directory][samples].\r\n\r\n* [A simple test][sample-simple]\r\n* [Using multiple suites][sample-suites]\r\n* [Tests with signals][sample-signal]\r\n* [Using report hooks][sample-report]\r\n\r\n## F.A.Q.\r\n\r\n**Q. What's wrong with other test frameworks?**\r\nA. I worked with CUnit and Check, and I must say that they do their job\r\n very well -- the only thing that bugs me is that setting up a test\r\n suite from scratch is a pain, it should really be simpler. Most\r\n (if not all) high-level languages have test frameworks with automatic\r\n test registration, but all the ones for C require you to set up a\r\n main, manually register suites, then tests. Criterion tries to\r\n fix these shortcomings.\r\n\r\n**Q. Where has this been tested?**\r\nA. Currently, on Linux 2.6.32 and Linux 3.15.7, although it should work on\r\n most \\*nix systems. More tests will be added on the build matrix.\r\n\r\n**Q. Will this work under Windows/MSVC?**\r\nA. Windows support with MinGW/MSVC is coming, but MSVC is a bit of a lost cause\r\n to compile the library itself: the project internally uses c99 features and gnu\r\n extensions.\r\n\r\n[online-docs]: http://criterion.readthedocs.org/\r\n[pdf-docs]: http://readthedocs.org/projects/criterion/downloads/pdf/latest/\r\n[zip-docs]: http://readthedocs.org/projects/criterion/downloads/htmlzip/latest/\r\n[epub-docs]: http://readthedocs.org/projects/criterion/downloads/epub/latest/\r\n\r\n[samples]: https://github.com/Snaipe/Criterion/tree/master/samples\r\n[sample-simple]: https://github.com/Snaipe/Criterion/blob/master/samples/simple.c\r\n[sample-suites]: https://github.com/Snaipe/Criterion/blob/master/samples/suites.c\r\n[sample-signal]: https://github.com/Snaipe/Criterion/blob/master/samples/signal.c\r\n[sample-report]: https://github.com/Snaipe/Criterion/blob/master/samples/report.c\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
|
||||
{"name":"Criterion","tagline":"A KISS, non-intrusive C test framework","body":"\r\nCriterion\r\n=========\r\n\r\n[](https://travis-ci.org/Snaipe/Criterion) \r\n[](https://coveralls.io/r/Snaipe/Criterion?branch=master) \r\n[](https://github.com/Snaipe/Criterion/blob/master/LICENSE) \r\n[](https://github.com/Snaipe/Criterion/releases) \r\n\r\nA dead-simple, yet extensible, C unit testing framework.\r\n\r\n\r\n\r\n## Philosophy\r\n\r\nMost test frameworks for C require a lot of boilerplate code to\r\nset up tests and test suites -- you need to create a main,\r\nthen register new test suites, then register the tests within\r\nthese suits, and finally call the right functions.\r\n\r\nThis gives the user great control, at the unfortunate cost of simplicity.\r\n\r\nCriterion follows the KISS principle, while keeping the control\r\nthe user would have with other frameworks:\r\n\r\n* [x] Tests are automatically registered when declared.\r\n* [x] Implements a xUnit framework structure.\r\n* [x] A default entry point is provided, no need to declare a main\r\n unless you want to do special handling.\r\n* [x] Test are isolated in their own process, crashes and signals can be\r\n reported and tested.\r\n* [x] Progress and statistics can be followed in real time with report hooks.\r\n* [x] TAP output format can be enabled with an option.\r\n* [x] Runs on Linux, FreeBSD, Mac OS X, and Windows (Compiles only with MinGW or Cygwin).\r\n\r\n## Downloads\r\n\r\n* [Linux (x86_64)](https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-linux-x86_64.tar.bz2)\r\n* [OS X (x86_64)](https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-osx-x86_64.tar.bz2)\r\n* [Windows (x86_64)](https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-win-x86_64.tar.bz2)\r\n* [FreeBSD (x86_64)](https://github.com/Snaipe/Criterion/releases/download/v1.1.0/criterion-1.1.0-freebsd-x86_64.tar.bz2)\r\n\r\nIf you have a different platform, you can still [build the library from source](http://criterion.readthedocs.org/en/latest/setup.html#installation)\r\n\r\n## Documentation\r\n\r\nAn online documentation is available on [ReadTheDocs][online-docs]\r\n([PDF][pdf-docs] | [Zip][zip-docs] | [Epub][epub-docs])\r\n\r\n## Samples\r\n\r\nSample tests can be found in the [sample directory][samples].\r\n\r\n* [A simple test][sample-simple]\r\n* [Using multiple suites][sample-suites]\r\n* [Writing assertions][sample-asserts]\r\n* [Adding test fixtures][sample-fixtures]\r\n* [Tests with signals][sample-signal]\r\n* [Using report hooks][sample-report]\r\n\r\n## F.A.Q.\r\n\r\n**Q. What's wrong with other test frameworks?** \r\nA. I worked with CUnit and Check, and I must say that they do their job\r\n very well -- the only thing that bugs me is that setting up a test\r\n suite from scratch is a pain, it should really be simpler. Most\r\n (if not all) high-level languages have test frameworks with automatic\r\n test registration, but all the ones for C require you to set up a\r\n main, manually register suites, then tests. Criterion tries to\r\n fix these shortcomings.\r\n\r\n**Q. Where has this been tested?** \r\nA. Currently, on Linux 2.6.32 and Linux 3.15.7, although it should work on\r\n most \\*nix systems; Mac OS X Yosemite 10.10, FreeBSD 10.0, and finally\r\n Windows 7 (with the MinGW and Cygwin ports of GCC).\r\n\r\n[online-docs]: http://criterion.readthedocs.org/\r\n[pdf-docs]: http://readthedocs.org/projects/criterion/downloads/pdf/latest/\r\n[zip-docs]: http://readthedocs.org/projects/criterion/downloads/htmlzip/latest/\r\n[epub-docs]: http://readthedocs.org/projects/criterion/downloads/epub/latest/\r\n\r\n[samples]: https://github.com/Snaipe/Criterion/tree/bleeding/samples/\r\n[sample-simple]: https://github.com/Snaipe/Criterion/blob/bleeding/samples/simple.c\r\n[sample-suites]: https://github.com/Snaipe/Criterion/blob/bleeding/samples/suites.c\r\n[sample-asserts]: https://github.com/Snaipe/Criterion/blob/bleeding/samples/asserts.c\r\n[sample-fixtures]: https://github.com/Snaipe/Criterion/blob/bleeding/samples/fixtures.c\r\n[sample-signal]: https://github.com/Snaipe/Criterion/blob/bleeding/samples/signal.c\r\n[sample-report]: https://github.com/Snaipe/Criterion/blob/bleeding/samples/report.c\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
|
||||
Loading…
Add table
Reference in a new issue