1<p align="center">
2  <img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" />
3</p>
4
5---
6
7<p align="center">
8  <a href="https://travis-ci.org/hoaproject/zformat"><img src="https://img.shields.io/travis/hoaproject/zformat/master.svg" alt="Build status" /></a>
9  <a href="https://coveralls.io/github/hoaproject/zformat?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/zformat/master.svg" alt="Code coverage" /></a>
10  <a href="https://packagist.org/packages/hoa/zformat"><img src="https://img.shields.io/packagist/dt/hoa/zformat.svg" alt="Packagist" /></a>
11  <a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/zformat.svg" alt="License" /></a>
12</p>
13<p align="center">
14  Hoa is a <strong>modular</strong>, <strong>extensible</strong> and
15  <strong>structured</strong> set of PHP libraries.<br />
16  Moreover, Hoa aims at being a bridge between industrial and research worlds.
17</p>
18
19# Hoa\Zformat
20
21[![Help on IRC](https://img.shields.io/badge/help-%23hoaproject-ff0066.svg)](https://webchat.freenode.net/?channels=#hoaproject)
22[![Help on Gitter](https://img.shields.io/badge/help-gitter-ff0066.svg)](https://gitter.im/hoaproject/central)
23[![Documentation](https://img.shields.io/badge/documentation-hack_book-ff0066.svg)](https://central.hoa-project.net/Documentation/Library/Zformat)
24[![Board](https://img.shields.io/badge/organisation-board-ff0066.svg)](https://waffle.io/hoaproject/zformat)
25
26This library provides a new format called zFormat, used to express complex
27parameters, for instance for classes.
28
29[Learn more](https://central.hoa-project.net/Documentation/Library/Zformat).
30
31## Installation
32
33With [Composer](https://getcomposer.org/), to include this library into
34your dependencies, you need to
35require [`hoa/zformat`](https://packagist.org/packages/hoa/zformat):
36
37```sh
38$ composer require hoa/zformat '~1.0'
39```
40
41For more installation procedures, please read [the Source
42page](https://hoa-project.net/Source.html).
43
44## Testing
45
46Before running the test suites, the development dependencies must be installed:
47
48```sh
49$ composer install
50```
51
52Then, to run all the test suites:
53
54```sh
55$ vendor/bin/hoa test:run
56```
57
58For more information, please read the [contributor
59guide](https://hoa-project.net/Literature/Contributor/Guide.html).
60
61## Quick usage
62
63…
64
65## Documentation
66
67The
68[hack book of `Hoa\Zformat`](https://central.hoa-project.net/Documentation/Library/Zformat)
69contains detailed information about how to use this library and how it works.
70
71To generate the documentation locally, execute the following commands:
72
73```sh
74$ composer require --dev hoa/devtools
75$ vendor/bin/hoa devtools:documentation --open
76```
77
78More documentation can be found on the project's website:
79[hoa-project.net](https://hoa-project.net/).
80
81## Getting help
82
83There are mainly two ways to get help:
84
85  * On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject)
86    IRC channel,
87  * On the forum at [users.hoa-project.net](https://users.hoa-project.net).
88
89## Contribution
90
91Do you want to contribute? Thanks! A detailed [contributor
92guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains
93everything you need to know.
94
95## License
96
97Hoa is under the New BSD License (BSD-3-Clause). Please, see
98[`LICENSE`](https://hoa-project.net/LICENSE) for details.
99