stv0g/Criterion
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated readme with docs, removed installation process, added footer links

Browse source
This commit is contained in:
Snaipe 2015-02-11 13:34:46 +01:00
parent 7eb03b68d0
commit ece20af1bc
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -28,30 +28,19 @@ the user would have with other frameworks:
reported and tested.
* Progress and statistics can be followed in real time with report hooks.
## Installation
## Documentation
```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`:
```bash
$ gcc -o test test.c -lcriterion
```
An online documentation is available on [ReadTheDocs][online-docs]
([PDF][pdf-docs] | [Zip][zip-docs] | [Epub][epub-docs])
## Samples
Sample tests can be found in the [sample directory](https://github.com/Snaipe/Criterion/tree/master/samples).
Sample tests can be found in the [sample directory][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)
* [A simple test][sample-simple]
* [Using multiple suites][sample-suites]
* [Tests with signals][sample-signal]
* [Using report hooks][sample-report]
## F.A.Q.
@ -72,3 +61,14 @@ A. Currently, on Linux 2.6.32 and Linux 3.15.7, although it should work on
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.
[online-docs]: http://criterion.readthedocs.org/
[pdf-docs]: http://readthedocs.org/projects/criterion/downloads/pdf/latest/
[zip-docs]: http://readthedocs.org/projects/criterion/downloads/htmlzip/latest/
[epub-docs]: http://readthedocs.org/projects/criterion/downloads/epub/latest/
[samples]: https://github.com/Snaipe/Criterion/tree/master/samples
[sample-simple]: https://github.com/Snaipe/Criterion/blob/master/samples/simple.c
[sample-suites]: https://github.com/Snaipe/Criterion/blob/master/samples/suites.c
[sample-signal]: https://github.com/Snaipe/Criterion/blob/master/samples/signal.c
[sample-report]: https://github.com/Snaipe/Criterion/blob/master/samples/report.c