Zformat

The Hoa\Zformat library.

259
10
PHP

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\Zformat

Help on IRC
Help on Gitter
Documentation
Board

This library provides a new format called zFormat, used to express complex
parameters, for instance for classes.

Learn more.

Installation

With Composer, to include this library into
your dependencies, you need to
require hoa/zformat:

$ composer require hoa/zformat '~1.0'

For more installation procedures, please read the Source
page
.

Testing

Before running the test suites, the development dependencies must be installed:

$ composer install

Then, to run all the test suites:

$ vendor/bin/hoa test:run

For more information, please read the contributor
guide
.

Quick usage

Documentation

The
hack book of Hoa\Zformat
contains detailed information about how to use this library and how it works.

To generate the documentation locally, execute the following commands:

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

More documentation can be found on the project’s website:
hoa-project.net.

Getting help

There are mainly two ways to get help:

Contribution

Do you want to contribute? Thanks! A detailed contributor
guide
explains
everything you need to know.

License

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