diff --git a/README.md b/README.md index 8d0e30b..cbf2095 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,64 @@ -![Hoa](http://static.hoa-project.net/Image/Hoa_small.png) - -Hoa is a **modular**, **extensible** and **structured** set of PHP libraries. -Moreover, Hoa aims at being a bridge between industrial and research worlds. - -# Hoa\Test ![state](http://central.hoa-project.net/State/Test) +

+ Hoa +

+ +--- + +

+ Build status + Code coverage + Packagist + License +

+

+ Hoa is a modular, extensible and + structured set of PHP libraries.
+ Moreover, Hoa aims at being a bridge between industrial and research worlds. +

+ +# Hoa\Test + +[![Help on IRC](https://img.shields.io/badge/help-%23hoaproject-ff0066.svg)](https://webchat.freenode.net/?channels=#hoaproject) +[![Help on Gitter](https://img.shields.io/badge/help-gitter-ff0066.svg)](https://gitter.im/hoaproject/central) +[![Documentation](https://img.shields.io/badge/documentation-hack_book-ff0066.svg)](https://central.hoa-project.net/Documentation/Library/Test) +[![Board](https://img.shields.io/badge/organisation-board-ff0066.svg)](https://waffle.io/hoaproject/test) This library provides tools to create and run tests for Hoa libraries. -In each library, a `Test/` directory contains test suites. So far, only unit -tests are supported. They are written with [atoum](http://atoum.org/). +In each library, a `Test/` directory contains test suites. They are +written with [atoum](http://atoum.org/). + +[Learn more](https://central.hoa-project.net/Documentation/Library/Test). ## Installation -With [Composer](http://getcomposer.org/), to include this library into your -dependencies, you need to require -[`hoa/test`](https://packagist.org/packages/hoa/test): +With [Composer](https://getcomposer.org/), to include this library into +your dependencies, you need to +require [`hoa/test`](https://packagist.org/packages/hoa/test): -```json -{ - "require": { - "hoa/test": "~2.0" - } -} +```sh +$ composer require hoa/test '~2.0' ``` -Please, read the website to [get more informations about how to -install](http://hoa-project.net/Source.html). +For more installation procedures, please read [the Source +page](https://hoa-project.net/Source.html). + +## Testing + +Before running the test suites, the development dependencies must be installed: + +```sh +$ composer install +``` + +Then, to run all the test suites: + +```sh +$ vendor/bin/hoa test:run +``` + +For more information, please read the [contributor +guide](https://hoa-project.net/Literature/Contributor/Guide.html). ## Quick usage @@ -136,17 +169,39 @@ to only run the test suite generated by the Praspel tools. ## Environment variables - * `HOA_ATOUM_BIN`: this variable represents the path to the atoum binary, - * `HOA_ATOUM_PRASPEL_EXTENSION`: this variable indicates the root of the - `Atoum\PraspelExtension` library (do not forget the trailing `/`!); useful - when Hoa is installed through the Central and not Composer. + * `HOA_ATOUM_BIN`: This variable represents the path to the atoum binary. ## Documentation -Different documentations can be found on the website: -[http://hoa-project.net/](http://hoa-project.net/). +The +[hack book of `Hoa\Test`](https://central.hoa-project.net/Documentation/Library/Test) contains +detailed information about how to use this library and how it works. + +To generate the documentation locally, execute the following commands: + +```sh +$ composer require --dev hoa/devtools +$ vendor/bin/hoa devtools:documentation --open +``` + +More documentation can be found on the project's website: +[hoa-project.net](https://hoa-project.net/). + +## Getting help + +There are mainly two ways to get help: + + * On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject) + IRC channel, + * On the forum at [users.hoa-project.net](https://users.hoa-project.net). + +## Contribution + +Do you want to contribute? Thanks! A detailed [contributor +guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains +everything you need to know. ## License -Hoa is under the New BSD License (BSD-3-Clause). Please, see -[`LICENSE`](http://hoa-project.net/LICENSE). +Hoa is under the New BSD License (BSD-3-Clause). Please, see +[`LICENSE`](https://hoa-project.net/LICENSE) for details.