hoa/zformat

The Hoa\Zformat library.

, _(*1)

, _(*2)

Hoa is a modular, extensible and structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds. , _(*3)

Hoa\Zformat

, _(*4)

This library provides a new format called zFormat, used to express complex parameters, for instance for classes., _(*5)

Learn more., _(*6)

Installation

With Composer, to include this library into your dependencies, you need to require hoa/zformat:, _(*7)

$ composer require hoa/zformat '~1.0'

For more installation procedures, please read the Source page., _(*8)

Testing

Before running the test suites, the development dependencies must be installed:, _(*9)

$ composer install

Then, to run all the test suites:, _(*10)

$ vendor/bin/hoa test:run

For more information, please read the contributor guide., _(*11)

Quick usage

…, _(*12)

Documentation

The hack book of Hoa\Zformat contains detailed information about how to use this library and how it works., _(*13)

To generate the documentation locally, execute the following commands:, _(*14)

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

More documentation can be found on the project's website: hoa-project.net., _(*15)

Getting help

There are mainly two ways to get help:, _(*16)

• On the #hoaproject IRC channel,
• On the forum at users.hoa-project.net.

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know., _(*17)

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details., _(*18)