diff --git a/README.md b/README.md index d04edfb..934c6e5 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,15 @@ Criterion ========= -[![Build Status](https://travis-ci.org/Snaipe/Criterion.svg?branch=master)](https://travis-ci.org/Snaipe/Criterion) -[![Coverage Status](https://coveralls.io/repos/Snaipe/Criterion/badge.svg?branch=master)](https://coveralls.io/r/Snaipe/Criterion?branch=master) -[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/Snaipe/Criterion/blob/master/LICENSE) +[![Build Status](https://travis-ci.org/Snaipe/Criterion.svg?branch=master)](https://travis-ci.org/Snaipe/Criterion) +[![Coverage Status](https://coveralls.io/repos/Snaipe/Criterion/badge.svg?branch=master)](https://coveralls.io/r/Snaipe/Criterion?branch=master) +[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/Snaipe/Criterion/blob/master/LICENSE) [![Version](https://img.shields.io/github/tag/Snaipe/Criterion.svg?label=version&style=flat)](https://github.com/Snaipe/Criterion/releases) A dead-simple, yet extensible, C test framework. +![Screencast](./doc/screencast.gif) + ## Philosophy Most test frameworks for C require a lot of boilerplate code to @@ -30,7 +32,7 @@ the user would have with other frameworks: ## Documentation -An online documentation is available on [ReadTheDocs][online-docs] +An online documentation is available on [ReadTheDocs][online-docs] ([PDF][pdf-docs] | [Zip][zip-docs] | [Epub][epub-docs]) ## Samples @@ -44,7 +46,7 @@ Sample tests can be found in the [sample directory][samples]. ## F.A.Q. -**Q. What's wrong with other test frameworks?** +**Q. What's wrong with other test frameworks?** 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 @@ -53,11 +55,11 @@ 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. -**Q. Where has this been tested?** +**Q. Where has this been tested?** 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. -**Q. Will this work under Windows/MSVC?** +**Q. Will this work under Windows/MSVC?** 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. diff --git a/doc/screencast.gif b/doc/screencast.gif new file mode 100644 index 0000000..4b3e7eb Binary files /dev/null and b/doc/screencast.gif differ