diff --git a/README.md b/README.md index 8ca7906..7edaf15 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,62 @@ -![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\Locale ![state](http://central.hoa-project.net/State/Locale) +

+ 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\Locale + +[![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/Locale) +[![Board](https://img.shields.io/badge/organisation-board-ff0066.svg)](https://waffle.io/hoaproject/locale) This library allows to get the informations of the locale from the system, the HTTP client or something else. +[Learn more](https://central.hoa-project.net/Documentation/Library/Locale). + ## Installation -With [Composer](http://getcomposer.org/), to include this library into your -dependencies, you need to require -[`hoa/locale`](https://packagist.org/packages/hoa/locale): +With [Composer](https://getcomposer.org/), to include this library into +your dependencies, you need to +require [`hoa/locale`](https://packagist.org/packages/hoa/locale): + +```sh +$ composer require hoa/locale '~2.0' +``` + +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: -```json -{ - "require": { - "hoa/locale": "~2.0" - } -} +```sh +$ vendor/bin/hoa test:run ``` -Please, read the website to [get more informations about how to -install](http://hoa-project.net/Source.html). +For more information, please read the [contributor +guide](https://hoa-project.net/Literature/Contributor/Guide.html). ## Quick usage @@ -71,10 +104,35 @@ an arbitrary locale representation. ## Documentation -Different documentations can be found on the website: -[http://hoa-project.net/](http://hoa-project.net/). +The +[hack book of `Hoa\Locale`](https://central.hoa-project.net/Documentation/Library/Locale) +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.