Create gh-pages branch via GitHub

This commit is contained in:
Franklin Mathieu 2016-06-24 19:29:57 +02:00 committed by GitHub
parent 8d72b14024
commit c155ff7038
12 changed files with 865 additions and 564 deletions

BIN
images/body-bg.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

BIN
images/download-button.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

BIN
images/github-button.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

BIN
images/header-bg.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

BIN
images/highlight-bg.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
images/sidebar-bg.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

View File

@ -1,55 +1,49 @@
<!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 https://github.com/jonrohan -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<link rel="stylesheet" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script type="text/javascript" src="javascripts/script.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>Criterion</title>
<meta name="description" content="A KISS, non-intrusive C test framework">
<title>Criterion by Snaipe</title>
</head>
<meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body>
<div class="wrapper">
<body>
<header>
<h1 class="title">Criterion</h1>
<div class="inner">
<h1>Criterion</h1>
<h2>A KISS, non-intrusive C test framework</h2>
<a href="https://github.com/Snaipe/Criterion" class="button"><small>View project on</small> GitHub</a>
</div>
</header>
<div id="container">
<p class="tagline">A KISS, non-intrusive C test framework</p>
<div id="main" role="main">
<div class="download-bar">
<div class="inner">
<a href="https://github.com/Snaipe/Criterion/tarball/master" class="download-button tar"><span>Download</span></a>
<a href="https://github.com/Snaipe/Criterion/zipball/master" class="download-button zip"><span>Download</span></a>
<a href="https://github.com/Snaipe/Criterion" class="code">View Criterion on GitHub</a>
</div>
<span class="blc"></span><span class="trc"></span>
</div>
<article class="markdown-body">
<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content">
<h1>
<a id="criterion" class="anchor" href="#criterion" aria-hidden="true"><span class="octicon octicon-link"></span></a>Criterion</h1>
<a id="" class="anchor" href="#" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><img src="https://raw.githubusercontent.com/Snaipe/Criterion/bleeding/doc/criterion-title.png" height="96" alt="Criterion Logo">
</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>
<p><a href="https://travis-ci.org/Snaipe/Criterion"><img src="https://travis-ci.org/Snaipe/Criterion.svg?branch=bleeding" alt="Unix Build Status"></a>
<a href="https://ci.appveyor.com/project/Snaipe/Criterion/branch/bleeding"><img src="https://ci.appveyor.com/api/projects/status/github/Snaipe/Criterion?svg=true&amp;branch=bleeding" alt="Windows Build Status"></a>
<a href="https://codecov.io/github/Snaipe/Criterion?branch=bleeding"><img src="https://img.shields.io/codecov/c/github/Snaipe/Criterion/bleeding.svg" 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&amp;style=flat" alt="Version"></a> </p>
<a href="https://github.com/Snaipe/Criterion/releases"><img src="https://img.shields.io/badge/version-v2.2.1-blue.svg?style=flat" alt="Version"></a> </p>
<p>A dead-simple, yet extensible, C unit testing framework.</p>
<p>A dead-simple, yet extensible, C and C++ unit testing framework.</p>
<p><img src="https://raw.githubusercontent.com/Snaipe/Criterion/bleeding/doc/screencast.gif" alt="Screencast"></p>
<h2>
<a id="philosophy" class="anchor" href="#philosophy" aria-hidden="true"><span class="octicon octicon-link"></span></a>Philosophy</h2>
<a id="philosophy" class="anchor" href="#philosophy" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Philosophy</h2>
<p>Most test frameworks for C require a lot of boilerplate code to
set up tests and test suites -- you need to create a main,
@ -62,37 +56,52 @@ these suits, and finally call the right functions.</p>
the user would have with other frameworks:</p>
<ul>
<li>[x] C99 and C++11 compatible.</li>
<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>[x] Test are isolated in their own process, crashes and signals can be
reported and tested.</li>
<li>[x] Unified interface between C and C++: include the criterion header and it <em>just</em> works.</li>
<li>[x] Supports parameterized tests and theories.</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>
<li>[x] Runs on Linux, FreeBSD, Mac OS X, and Windows (Compiling with MinGW GCC and Visual Studio 2015+).</li>
</ul>
<h2>
<a id="downloads" class="anchor" href="#downloads" aria-hidden="true"><span class="octicon octicon-link"></span></a>Downloads</h2>
<a id="downloads" class="anchor" href="#downloads" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Downloads</h2>
<h3>
<a id="packages" class="anchor" href="#packages" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Packages</h3>
<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>
<li>Mac OS X: <code>brew install snaipe/soft/criterion</code>
</li>
<li>
<a href="https://aur.archlinux.org/packages/criterion/">AUR</a>: <code>yaourt -S criterion</code>
</li>
</ul>
<h3>
<a id="binary-archives" class="anchor" href="#binary-archives" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Binary archives</h3>
<p>Binary releases are available <a href="https://github.com/Snaipe/Criterion/releases">on the release page</a></p>
<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>
<a id="developer-resources" class="anchor" href="#developer-resources" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Developer Resources</h2>
<h3>
<a id="documentation" class="anchor" href="#documentation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Documentation</h3>
<p>An online documentation is available on <a href="http://criterion.readthedocs.org/">ReadTheDocs</a>
(<a href="http://readthedocs.org/projects/criterion/downloads/pdf/latest/">PDF</a> | <a href="http://readthedocs.org/projects/criterion/downloads/htmlzip/latest/">Zip</a> | <a href="http://readthedocs.org/projects/criterion/downloads/epub/latest/">Epub</a>)</p>
<h2>
<a id="samples" class="anchor" href="#samples" aria-hidden="true"><span class="octicon octicon-link"></span></a>Samples</h2>
<h3>
<a id="samples" class="anchor" href="#samples" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Samples</h3>
<p>Sample tests can be found in the <a href="https://github.com/Snaipe/Criterion/tree/bleeding/samples/">sample directory</a>.</p>
@ -105,42 +114,60 @@ reported and tested.</li>
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/samples/report.c">Using report hooks</a></li>
</ul>
<h3>
<a id="getting-help" class="anchor" href="#getting-help" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Getting help</h3>
<table>
<thead>
<tr>
<th>Channel</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://gitter.im/Snaipe/Criterion?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/Snaipe/Criterion"></a></td>
<td>
<code>Snaipe/Criterion</code> on gitter.im</td>
</tr>
<tr>
<td><a href="http://webchat.freenode.net/?channels=%23criterion&amp;uio=MTY9dHJ1ZSYyPXRydWUmOT10cnVlJjExPTE5NQ4e"><img src="https://img.shields.io/badge/irc-%23criterion-46BC99.svg" alt="Join #criterion on freenode"></a></td>
<td>
<code>#criterion</code> on irc.freenode.net</td>
</tr>
</tbody>
</table>
<h3>
<a id="misc" class="anchor" href="#misc" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Misc</h3>
<ul>
<li><a href="https://github.com/Snaipe/Criterion/blob/bleeding/dev/FindCriterion.cmake">CMake find module for Criterion</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>
<a id="credits" class="anchor" href="#credits" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Credits</h2>
<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
(if not all) high-level languages have test frameworks with automatic
test registration, but all the ones for C require you to set up a
main, manually register suites, then tests. Criterion tries to
fix these shortcomings.</p>
<p>Logo made by <a href="http://www.cargocollective.com/pbouigue">Paul Bouigue</a></p>
</section>
<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; Mac OS X Yosemite 10.10, FreeBSD 10.0, and finally
Windows 7 (with the MinGW and Cygwin ports of GCC).</p>
</article>
<aside id="sidebar">
<a href="https://github.com/Snaipe/Criterion/zipball/master" class="button">
<small>Download</small>
.zip file
</a>
<a href="https://github.com/Snaipe/Criterion/tarball/master" class="button">
<small>Download</small>
.tar.gz file
</a>
<p class="repo-owner"><a href="https://github.com/Snaipe/Criterion"></a> is maintained by <a href="https://github.com/Snaipe">Snaipe</a>.</p>
<p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the Architect theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.</p>
</aside>
</div>
</div>
<footer>
<div class="owner">
<p><a href="https://github.com/Snaipe" class="avatar"><img src="https://avatars0.githubusercontent.com/u/977973?v=3&amp;s=60" width="48" height="48"></a> <a href="https://github.com/Snaipe">Snaipe</a> maintains <a href="https://github.com/Snaipe/Criterion">Criterion</a></p>
</div>
<div class="creds">
<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>
<div class="current-section">
<a href="#top">Scroll to top</a>
<a href="https://github.com/Snaipe/Criterion/tarball/master" class="tar">tar</a><a href="https://github.com/Snaipe/Criterion/zipball/master" class="zip">zip</a><a href="" class="code">source code</a>
<p class="name"></p>
</div>
</body>
</body>
</html>

1
javascripts/main.js Normal file
View File

@ -0,0 +1 @@
console.log('This would be the main JS file.');

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,124 @@
/*
The MIT License (MIT)
Copyright (c) 2016 GitHub, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
.pl-c /* comment */ {
color: #969896;
}
.pl-c1 /* constant, variable.other.constant, support, meta.property-name, support.constant, support.variable, meta.module-reference, markup.raw, meta.diff.header */,
.pl-s .pl-v /* string variable */ {
color: #0086b3;
}
.pl-e /* entity */,
.pl-en /* entity.name */ {
color: #795da3;
}
.pl-smi /* variable.parameter.function, storage.modifier.package, storage.modifier.import, storage.type.java, variable.other */,
.pl-s .pl-s1 /* string source */ {
color: #333;
}
.pl-ent /* entity.name.tag */ {
color: #63a35c;
}
.pl-k /* keyword, storage, storage.type */ {
color: #a71d5d;
}
.pl-s /* string */,
.pl-pds /* punctuation.definition.string, string.regexp.character-class */,
.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
.pl-sr /* string.regexp */,
.pl-sr .pl-cce /* string.regexp constant.character.escape */,
.pl-sr .pl-sre /* string.regexp source.ruby.embedded */,
.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */ {
color: #183691;
}
.pl-v /* variable */ {
color: #ed6a43;
}
.pl-id /* invalid.deprecated */ {
color: #b52a1d;
}
.pl-ii /* invalid.illegal */ {
color: #f8f8f8;
background-color: #b52a1d;
}
.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
font-weight: bold;
color: #63a35c;
}
.pl-ml /* markup.list */ {
color: #693a17;
}
.pl-mh /* markup.heading */,
.pl-mh .pl-en /* markup.heading entity.name */,
.pl-ms /* meta.separator */ {
font-weight: bold;
color: #1d3e81;
}
.pl-mq /* markup.quote */ {
color: #008080;
}
.pl-mi /* markup.italic */ {
font-style: italic;
color: #333;
}
.pl-mb /* markup.bold */ {
font-weight: bold;
color: #333;
}
.pl-md /* markup.deleted, meta.diff.header.from-file */ {
color: #bd2c00;
background-color: #ffecec;
}
.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
color: #55a532;
background-color: #eaffea;
}
.pl-mdr /* meta.diff.range */ {
font-weight: bold;
color: #795da3;
}
.pl-mo /* meta.output */ {
color: #1d3e81;
}

228
stylesheets/print.css Normal file
View File

@ -0,0 +1,228 @@
html, body, div, span, applet, object, iframe,
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
a, abbr, acronym, address, big, cite, code,
del, dfn, em, img, ins, kbd, q, s, samp,
small, strike, strong, sub, sup, tt, var,
b, u, i, center,
dl, dt, dd, ol, ul, li,
fieldset, form, label, legend,
table, caption, tbody, tfoot, thead, tr, th, td,
article, aside, canvas, details, embed,
figure, figcaption, footer, header, hgroup,
menu, nav, output, ruby, section, summary,
time, mark, audio, video {
padding: 0;
margin: 0;
font: inherit;
font-size: 100%;
vertical-align: baseline;
border: 0;
}
/* HTML5 display-role reset for older browsers */
article, aside, details, figcaption, figure,
footer, header, hgroup, menu, nav, section {
display: block;
}
body {
line-height: 1;
}
ol, ul {
list-style: none;
}
blockquote, q {
quotes: none;
}
blockquote:before, blockquote:after,
q:before, q:after {
content: '';
content: none;
}
table {
border-spacing: 0;
border-collapse: collapse;
}
body {
font-family: 'Helvetica Neue', Helvetica, Arial, serif;
font-size: 13px;
line-height: 1.5;
color: #000;
}
a {
font-weight: bold;
color: #d5000d;
}
header {
padding-top: 35px;
padding-bottom: 10px;
}
header h1 {
font-size: 48px;
font-weight: bold;
line-height: 1.2;
color: #303030;
letter-spacing: -1px;
}
header h2 {
font-size: 24px;
font-weight: normal;
line-height: 1.3;
color: #aaa;
letter-spacing: -1px;
}
#downloads {
display: none;
}
#main_content {
padding-top: 20px;
}
code, pre {
margin-bottom: 30px;
font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal;
font-size: 12px;
color: #222;
}
code {
padding: 0 3px;
}
pre {
padding: 20px;
overflow: auto;
border: solid 1px #ddd;
}
pre code {
padding: 0;
}
ul, ol, dl {
margin-bottom: 20px;
}
/* COMMON STYLES */
table {
width: 100%;
border: 1px solid #ebebeb;
}
th {
font-weight: 500;
}
td {
font-weight: 300;
text-align: center;
border: 1px solid #ebebeb;
}
form {
padding: 20px;
background: #f2f2f2;
}
/* GENERAL ELEMENT TYPE STYLES */
h1 {
font-size: 2.8em;
}
h2 {
margin-bottom: 8px;
font-size: 22px;
font-weight: bold;
color: #303030;
}
h3 {
margin-bottom: 8px;
font-size: 18px;
font-weight: bold;
color: #d5000d;
}
h4 {
font-size: 16px;
font-weight: bold;
color: #303030;
}
h5 {
font-size: 1em;
color: #303030;
}
h6 {
font-size: .8em;
color: #303030;
}
p {
margin-bottom: 20px;
font-weight: 300;
}
a {
text-decoration: none;
}
p a {
font-weight: 400;
}
blockquote {
padding: 0 0 0 30px;
margin-bottom: 20px;
font-size: 1.6em;
border-left: 10px solid #e9e9e9;
}
ul li {
padding-left: 20px;
list-style-position: inside;
list-style: disc;
}
ol li {
padding-left: 3px;
list-style-position: inside;
list-style: decimal;
}
dl dd {
font-style: italic;
font-weight: 100;
}
footer {
padding-top: 20px;
padding-bottom: 30px;
margin-top: 40px;
font-size: 13px;
color: #aaa;
}
footer a {
color: #666;
}
/* MISC */
.clearfix:after {
display: block;
height: 0;
clear: both;
visibility: hidden;
content: '.';
}
.clearfix {display: inline-block;}
* html .clearfix {height: 1%;}
.clearfix {display: block;}

File diff suppressed because it is too large Load Diff