/peridot

Event driven BDD test framework for PHP

Primary LanguagePHPMIT LicenseMIT

Peridot logo

Build Status HHVM Status Scrutinizer Code Quality Coverage Status

The highly extensible, highly enjoyable, PHP testing framework.

Read more at peridot-php.github.io or head over to the wiki.

##Building PHAR

Peridot's phar is built using Box. Once box is installed, the phar can be built using the following command from the project directory:

box build

##Generating Peridot's documentation

Peridot API documentation is generated using apigen. Once apigen is installed, run the following command from the project directory:

apigen generate

This will output documentation to the docs/ directory.

##Running Peridot's tests

Peridot's test suite can be run using Peridot:

$ bin/peridot specs/

And a sample of output:

Peridot output sample

##Release

We use Robo for releases.

robo release [version] [site-path]