Put a one-line description of your project here.
Enable those services shown below that have not already been configured:
Feature | Setup |
---|---|
Collaborative repository | DONE |
Linux permutation testing | DONE |
Windows testing | Enable Appveyor CI |
Static analysis | Enable Scrutinizer CI |
Code coverage | Enable Coveralls |
Package manager | Register with Packagist |
Dependency updates | Enable Dependencies.io |
Then, delete this section and finish customizing this README.
Explain how to get a copy of this project up and running on a new user's local machine.
See deployment for notes on how to deploy the project on a live system.
List the things that are needed to install the software and how to install them. For most PHP projects, it should usually be sufficient to run:
composer install
Provide a step by step series of examples that show how to install this project.
Say what the step will be:
Give the example
And repeat:
until finished
End with an example of getting some data out of the system or using it for a little demo.
The test suite may be run locally by way of some simple composer scripts:
Test | Command |
---|---|
Run all tests | composer test |
PHPUnit tests | composer unit |
PHP linter | composer lint |
Code style | composer cs |
Fix style errors | composer cbf |
Add additional notes about how to deploy this on a live system.
- Composer - Dependency Management
Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Greg Anderson - created project from template.
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE file for details
- Hat tip to anyone who's code was used
- Inspiration
- etc
- Thanks to PurpleBooth for the example README template