Converted README to ReStructuredText

README.rst

@@ -0,0 +1,83 @@
+
+Criterion
+=========
+
+.. image:: https://travis-ci.org/Snaipe/Criterion.svg?branch=master
+  :target: https://travis-ci.org/Snaipe/Criterion 
+.. image:: https://coveralls.io/repos/Snaipe/Criterion/badge.svg?branch=master
+  :target: https://coveralls.io/r/Snaipe/Criterion?branch=master 
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
+  :target: https://github.com/Snaipe/Criterion/blob/master/LICENSE 
+.. image:: https://img.shields.io/github/tag/Snaipe/Criterion.svg?label=version&style=flat
+  :target: https://github.com/Snaipe/Criterion/releases 
+
+A dead-simple, yet extensible, C test framework.
+
+Philosophy
+----------
+
+Most test frameworks for C require a lot of boilerplate code to
+set up tests and test suites -- you need to create a main,
+then register new test suites, then register the tests within
+these suits, and finally call the right functions.
+
+This gives the user great control, at the unfortunate cost of simplicity.
+
+Criterion follows the KISS principle, while keeping the control
+the user would have with other frameworks:
+
+* Tests are automatically registered when declared.
+* A default entry point is provided, no need to declare a main
+  unless you want to do special handling.
+* Test are isolated in their own process, crashes and signals can be
+  reported and tested.
+* Progress and statistics can be followed in real time with report hooks.
+
+Installation
+------------
+
+.. code-block:: bash
+
+    $ git clone https://github.com/Snaipe/Criterion.git
+    $ cd Criterion
+    $ ./autogen.sh && ./configure && make && sudo make install
+
+Usage
+-----
+
+Given a test file named test.c, compile it with `-lcriterion`:
+
+.. code-block:: bash
+
+    $ gcc -o test test.c -lcriterion
+
+Samples
+-------
+
+Sample tests can be found in the `sample directory <https://github.com/Snaipe/Criterion/tree/master/samples>`_.
+
+* `A simple test <https://github.com/Snaipe/Criterion/blob/master/samples/simple.c>`_
+* `Using multiple suites <https://github.com/Snaipe/Criterion/blob/master/samples/suites.c>`_
+* `Tests with signals <https://github.com/Snaipe/Criterion/blob/master/samples/signal.c>`_
+* `Using report hooks <https://github.com/Snaipe/Criterion/blob/master/samples/report.c>`_
+
+F.A.Q.
+------
+
+**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
+(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.
+
+**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?**  
+A. Windows support with MinGW is coming, but MSVC is a bit of a lost cause
+for the C language. The project internally uses c99 features and gnu
+extensions, and MSVC is stuck at supporting c89.