Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adanda committed May 27, 2012
1 parent cb0bd06 commit 823cea1
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ php projects. It is based on [Silex][1], a PHP micro framework.
CIPS supports projects hosted in a Subversion or Git repository.

Currently CIPS supports tests which return a non-zero exit code when tests do
not pass as well as checkstyle results (like PHP Codesniffer).
not pass, checkstyle results (like PHP Codesniffer), code coverage in clover
format (as provided by PHPUnit) as well as a link to the project documentation.

CIPS works with PHP 5.3.2 or later.

Expand Down Expand Up @@ -86,6 +87,20 @@ Because the report file in the example is generated with a relative path, there
is a problem in cause the file does not exist. In this case it will not be
generated, therefore you have to create it manually before the first build.

### Checkstyle

You can set a link to the documentation of your project in
``config/projects.php``.

You can set the link like in the following example:

```php
<?php

$your_project->setDocumentationLink('http://link/to/your/documentation');
```
You can create your documentation as a post build command in your project.

## License

CIPS is licensed under the MIT license.
Expand Down

0 comments on commit 823cea1

Please sign in to comment.